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, |
| 42 | <a href='#SkPaint_kVerticalText_Flag'>kVerticalText_Flag</a> = 0x1000, |
| 43 | <a href='#SkPaint_kAllFlags'>kAllFlags</a> = 0xFFFF, |
| 44 | }; |
| 45 | |
| 46 | enum <a href='#SkPaint_ReserveFlags'>ReserveFlags</a> { |
| 47 | <a href='#SkPaint_kUnderlineText_ReserveFlag'>kUnderlineText_ReserveFlag</a> = 0x08, |
| 48 | <a href='#SkPaint_kStrikeThruText_ReserveFlag'>kStrikeThruText_ReserveFlag</a> = 0x10, |
| 49 | }; |
| 50 | |
| 51 | uint32_t <a href='#SkPaint_getFlags'>getFlags</a>() const; |
| 52 | void <a href='#SkPaint_setFlags'>setFlags</a>(uint32_t flags); |
| 53 | bool <a href='#SkPaint_isAntiAlias'>isAntiAlias</a>() const; |
| 54 | void <a href='#SkPaint_setAntiAlias'>setAntiAlias</a>(bool aa); |
| 55 | bool <a href='#SkPaint_isDither'>isDither</a>() const; |
| 56 | void <a href='#SkPaint_setDither'>setDither</a>(bool dither); |
| 57 | bool <a href='#SkPaint_isLinearText'>isLinearText</a>() const; |
| 58 | void <a href='#SkPaint_setLinearText'>setLinearText</a>(bool linearText); |
| 59 | bool <a href='#SkPaint_isSubpixelText'>isSubpixelText</a>() const; |
| 60 | void <a href='#SkPaint_setSubpixelText'>setSubpixelText</a>(bool subpixelText); |
| 61 | bool <a href='#SkPaint_isLCDRenderText'>isLCDRenderText</a>() const; |
| 62 | void <a href='#SkPaint_setLCDRenderText'>setLCDRenderText</a>(bool lcdText); |
| 63 | bool <a href='#SkPaint_isEmbeddedBitmapText'>isEmbeddedBitmapText</a>() const; |
| 64 | void <a href='#SkPaint_setEmbeddedBitmapText'>setEmbeddedBitmapText</a>(bool useEmbeddedBitmapText); |
| 65 | bool <a href='#SkPaint_isAutohinted'>isAutohinted</a>() const; |
| 66 | void <a href='#SkPaint_setAutohinted'>setAutohinted</a>(bool useAutohinter); |
| 67 | bool <a href='#SkPaint_isVerticalText'>isVerticalText</a>() const; |
| 68 | void <a href='#SkPaint_setVerticalText'>setVerticalText</a>(bool verticalText); |
| 69 | bool <a href='#SkPaint_isFakeBoldText'>isFakeBoldText</a>() const; |
| 70 | void <a href='#SkPaint_setFakeBoldText'>setFakeBoldText</a>(bool fakeBoldText); |
| 71 | bool <a href='#SkPaint_isDevKernText'>isDevKernText</a>() const; |
| 72 | void <a href='#SkPaint_setDevKernText'>setDevKernText</a>(bool); |
| 73 | <a href='undocumented#SkFilterQuality'>SkFilterQuality</a> <a href='#SkPaint_getFilterQuality'>getFilterQuality</a>() const; |
| 74 | void <a href='#SkPaint_setFilterQuality'>setFilterQuality</a>(<a href='undocumented#SkFilterQuality'>SkFilterQuality</a> quality); |
| 75 | |
| 76 | enum <a href='#SkPaint_Style'>Style</a> { |
| 77 | <a href='#SkPaint_kFill_Style'>kFill_Style</a>, |
| 78 | <a href='#SkPaint_kStroke_Style'>kStroke_Style</a>, |
| 79 | <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a>, |
| 80 | }; |
| 81 | |
| 82 | static constexpr int <a href='#SkPaint_kStyleCount'>kStyleCount</a> = <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a> + 1; |
| 83 | |
| 84 | <a href='#SkPaint_Style'>Style</a> <a href='#SkPaint_getStyle'>getStyle</a>() const; |
| 85 | void <a href='#SkPaint_setStyle'>setStyle</a>(<a href='#SkPaint_Style'>Style</a> style); |
| 86 | <a href='SkColor_Reference#SkColor'>SkColor</a> <a href='#SkPaint_getColor'>getColor</a>() const; |
| 87 | <a href='SkColor4f_Reference#SkColor4f'>SkColor4f</a> <a href='#SkPaint_getColor4f'>getColor4f</a>() const; |
| 88 | void <a href='#SkPaint_setColor'>setColor</a>(<a href='SkColor_Reference#SkColor'>SkColor</a> color); |
| 89 | void <a href='#SkPaint_setColor4f'>setColor4f</a>(const <a href='SkColor4f_Reference#SkColor4f'>SkColor4f</a>& color, <a href='undocumented#SkColorSpace'>SkColorSpace</a>* colorSpace); |
| 90 | uint8_t <a href='#SkPaint_getAlpha'>getAlpha</a>() const; |
| 91 | void <a href='#SkPaint_setAlpha'>setAlpha</a>(<a href='undocumented#U8CPU'>U8CPU</a> a); |
| 92 | 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); |
| 93 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getStrokeWidth'>getStrokeWidth</a>() const; |
| 94 | void <a href='#SkPaint_setStrokeWidth'>setStrokeWidth</a>(<a href='undocumented#SkScalar'>SkScalar</a> width); |
| 95 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getStrokeMiter'>getStrokeMiter</a>() const; |
| 96 | void <a href='#SkPaint_setStrokeMiter'>setStrokeMiter</a>(<a href='undocumented#SkScalar'>SkScalar</a> miter); |
| 97 | |
| 98 | enum <a href='#SkPaint_Cap'>Cap</a> { |
| 99 | <a href='#SkPaint_kButt_Cap'>kButt_Cap</a>, |
| 100 | <a href='#SkPaint_kRound_Cap'>kRound_Cap</a>, |
| 101 | <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a>, |
| 102 | <a href='#SkPaint_kLast_Cap'>kLast_Cap</a> = <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a>, |
| 103 | <a href='#SkPaint_kDefault_Cap'>kDefault_Cap</a> = <a href='#SkPaint_kButt_Cap'>kButt_Cap</a>, |
| 104 | }; |
| 105 | |
| 106 | static constexpr int <a href='#SkPaint_kCapCount'>kCapCount</a> = <a href='#SkPaint_kLast_Cap'>kLast_Cap</a> + 1; |
| 107 | |
| 108 | enum <a href='#SkPaint_Join'>Join</a> { |
| 109 | <a href='#SkPaint_kMiter_Join'>kMiter_Join</a>, |
| 110 | <a href='#SkPaint_kRound_Join'>kRound_Join</a>, |
| 111 | <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>, |
| 112 | <a href='#SkPaint_kLast_Join'>kLast_Join</a> = <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>, |
| 113 | <a href='#SkPaint_kDefault_Join'>kDefault_Join</a> = <a href='#SkPaint_kMiter_Join'>kMiter_Join</a>, |
| 114 | }; |
| 115 | |
| 116 | static constexpr int <a href='#SkPaint_kJoinCount'>kJoinCount</a> = <a href='#SkPaint_kLast_Join'>kLast_Join</a> + 1; |
| 117 | |
| 118 | <a href='#SkPaint_Cap'>Cap</a> <a href='#SkPaint_getStrokeCap'>getStrokeCap</a>() const; |
| 119 | void <a href='#SkPaint_setStrokeCap'>setStrokeCap</a>(<a href='#SkPaint_Cap'>Cap</a> cap); |
| 120 | <a href='#SkPaint_Join'>Join</a> <a href='#SkPaint_getStrokeJoin'>getStrokeJoin</a>() const; |
| 121 | void <a href='#SkPaint_setStrokeJoin'>setStrokeJoin</a>(<a href='#SkPaint_Join'>Join</a> join); |
| 122 | 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, |
| 123 | <a href='undocumented#SkScalar'>SkScalar</a> resScale = 1) const; |
| 124 | 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; |
| 125 | <a href='undocumented#SkShader'>SkShader</a>* <a href='#SkPaint_getShader'>getShader</a>() const; |
| 126 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkShader'>SkShader</a>> <a href='#SkPaint_refShader'>refShader</a>() const; |
| 127 | void <a href='#SkPaint_setShader'>setShader</a>(sk_sp<<a href='undocumented#SkShader'>SkShader</a>> shader); |
| 128 | <a href='undocumented#SkColorFilter'>SkColorFilter</a>* <a href='#SkPaint_getColorFilter'>getColorFilter</a>() const; |
| 129 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkColorFilter'>SkColorFilter</a>> <a href='#SkPaint_refColorFilter'>refColorFilter</a>() const; |
| 130 | void <a href='#SkPaint_setColorFilter'>setColorFilter</a>(sk_sp<<a href='undocumented#SkColorFilter'>SkColorFilter</a>> colorFilter); |
| 131 | <a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a> <a href='#SkPaint_getBlendMode'>getBlendMode</a>() const; |
| 132 | bool <a href='#SkPaint_isSrcOver'>isSrcOver</a>() const; |
| 133 | void <a href='#SkPaint_setBlendMode'>setBlendMode</a>(<a href='SkBlendMode_Reference#SkBlendMode'>SkBlendMode</a> mode); |
| 134 | <a href='undocumented#SkPathEffect'>SkPathEffect</a>* <a href='#SkPaint_getPathEffect'>getPathEffect</a>() const; |
| 135 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkPathEffect'>SkPathEffect</a>> <a href='#SkPaint_refPathEffect'>refPathEffect</a>() const; |
| 136 | void <a href='#SkPaint_setPathEffect'>setPathEffect</a>(sk_sp<<a href='undocumented#SkPathEffect'>SkPathEffect</a>> pathEffect); |
| 137 | <a href='undocumented#SkMaskFilter'>SkMaskFilter</a>* <a href='#SkPaint_getMaskFilter'>getMaskFilter</a>() const; |
| 138 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkMaskFilter'>SkMaskFilter</a>> <a href='#SkPaint_refMaskFilter'>refMaskFilter</a>() const; |
| 139 | void <a href='#SkPaint_setMaskFilter'>setMaskFilter</a>(sk_sp<<a href='undocumented#SkMaskFilter'>SkMaskFilter</a>> maskFilter); |
| 140 | <a href='undocumented#SkTypeface'>SkTypeface</a>* <a href='#SkPaint_getTypeface'>getTypeface</a>() const; |
| 141 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkTypeface'>SkTypeface</a>> <a href='#SkPaint_refTypeface'>refTypeface</a>() const; |
| 142 | void <a href='#SkPaint_setTypeface'>setTypeface</a>(sk_sp<<a href='undocumented#SkTypeface'>SkTypeface</a>> typeface); |
| 143 | <a href='undocumented#SkImageFilter'>SkImageFilter</a>* <a href='#SkPaint_getImageFilter'>getImageFilter</a>() const; |
| 144 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkImageFilter'>SkImageFilter</a>> <a href='#SkPaint_refImageFilter'>refImageFilter</a>() const; |
| 145 | void <a href='#SkPaint_setImageFilter'>setImageFilter</a>(sk_sp<<a href='undocumented#SkImageFilter'>SkImageFilter</a>> imageFilter); |
| 146 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a>* <a href='#SkPaint_getDrawLooper'>getDrawLooper</a>() const; |
| 147 | <a href='undocumented#sk_sp'>sk_sp</a><<a href='undocumented#SkDrawLooper'>SkDrawLooper</a>> <a href='#SkPaint_refDrawLooper'>refDrawLooper</a>() const; |
| 148 | <a href='undocumented#SkDrawLooper'>SkDrawLooper</a>* <a href='#SkPaint_getLooper'>getLooper</a>() const; |
| 149 | void <a href='#SkPaint_setDrawLooper'>setDrawLooper</a>(sk_sp<<a href='undocumented#SkDrawLooper'>SkDrawLooper</a>> drawLooper); |
| 150 | void <a href='#SkPaint_setLooper'>setLooper</a>(sk_sp<<a href='undocumented#SkDrawLooper'>SkDrawLooper</a>> drawLooper); |
| 151 | |
| 152 | enum <a href='#SkPaint_Align'>Align</a> { |
| 153 | <a href='#SkPaint_kLeft_Align'>kLeft_Align</a>, |
| 154 | <a href='#SkPaint_kCenter_Align'>kCenter_Align</a>, |
| 155 | <a href='#SkPaint_kRight_Align'>kRight_Align</a>, |
| 156 | }; |
| 157 | |
| 158 | static constexpr int <a href='#SkPaint_kAlignCount'>kAlignCount</a> = 3; |
| 159 | |
| 160 | <a href='#SkPaint_Align'>Align</a> <a href='#SkPaint_getTextAlign'>getTextAlign</a>() const; |
| 161 | void <a href='#SkPaint_setTextAlign'>setTextAlign</a>(<a href='#SkPaint_Align'>Align</a> align); |
| 162 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getTextSize'>getTextSize</a>() const; |
| 163 | void <a href='#SkPaint_setTextSize'>setTextSize</a>(<a href='undocumented#SkScalar'>SkScalar</a> textSize); |
| 164 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getTextScaleX'>getTextScaleX</a>() const; |
| 165 | void <a href='#SkPaint_setTextScaleX'>setTextScaleX</a>(<a href='undocumented#SkScalar'>SkScalar</a> scaleX); |
| 166 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getTextSkewX'>getTextSkewX</a>() const; |
| 167 | void <a href='#SkPaint_setTextSkewX'>setTextSkewX</a>(<a href='undocumented#SkScalar'>SkScalar</a> skewX); |
| 168 | |
| 169 | enum <a href='#SkPaint_TextEncoding'>TextEncoding</a> { |
| 170 | <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8_TextEncoding</a>, |
| 171 | <a href='#SkPaint_kUTF16_TextEncoding'>kUTF16_TextEncoding</a>, |
| 172 | <a href='#SkPaint_kUTF32_TextEncoding'>kUTF32_TextEncoding</a>, |
| 173 | <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID_TextEncoding</a>, |
| 174 | }; |
| 175 | |
| 176 | <a href='#SkPaint_TextEncoding'>TextEncoding</a> <a href='#SkPaint_getTextEncoding'>getTextEncoding</a>() const; |
| 177 | void <a href='#SkPaint_setTextEncoding'>setTextEncoding</a>(<a href='#SkPaint_TextEncoding'>TextEncoding</a> encoding); |
| 178 | |
| 179 | struct <a href='#SkPaint_FontMetrics'>FontMetrics</a> { |
| 180 | |
| 181 | enum <a href='#SkPaint_FontMetrics_FontMetricsFlags'>FontMetricsFlags</a> { |
| 182 | <a href='#SkPaint_FontMetrics_kUnderlineThicknessIsValid_Flag'>kUnderlineThicknessIsValid_Flag</a> = 1 << 0, |
| 183 | <a href='#SkPaint_FontMetrics_kUnderlinePositionIsValid_Flag'>kUnderlinePositionIsValid_Flag</a> = 1 << 1, |
| 184 | <a href='#SkPaint_FontMetrics_kStrikeoutThicknessIsValid_Flag'>kStrikeoutThicknessIsValid_Flag</a> = 1 << 2, |
| 185 | <a href='#SkPaint_FontMetrics_kStrikeoutPositionIsValid_Flag'>kStrikeoutPositionIsValid_Flag</a> = 1 << 3, |
| 186 | }; |
| 187 | |
| 188 | uint32_t <a href='#SkPaint_FontMetrics_fFlags'>fFlags</a>; |
| 189 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fTop'>fTop</a>; |
| 190 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fAscent'>fAscent</a>; |
| 191 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fDescent'>fDescent</a>; |
| 192 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fBottom'>fBottom</a>; |
| 193 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fLeading'>fLeading</a>; |
| 194 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fAvgCharWidth'>fAvgCharWidth</a>; |
| 195 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fMaxCharWidth'>fMaxCharWidth</a>; |
| 196 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fXMin'>fXMin</a>; |
| 197 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fXMax'>fXMax</a>; |
| 198 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fXHeight'>fXHeight</a>; |
| 199 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fCapHeight'>fCapHeight</a>; |
| 200 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fUnderlineThickness'>fUnderlineThickness</a>; |
| 201 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fUnderlinePosition'>fUnderlinePosition</a>; |
| 202 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fStrikeoutThickness'>fStrikeoutThickness</a>; |
| 203 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fStrikeoutPosition'>fStrikeoutPosition</a>; |
| 204 | bool <a href='#SkPaint_FontMetrics_hasUnderlineThickness'>hasUnderlineThickness</a>(<a href='undocumented#SkScalar'>SkScalar</a>* thickness) const; |
| 205 | bool <a href='#SkPaint_FontMetrics_hasUnderlinePosition'>hasUnderlinePosition</a>(<a href='undocumented#SkScalar'>SkScalar</a>* position) const; |
| 206 | bool <a href='#SkPaint_FontMetrics_hasStrikeoutThickness'>hasStrikeoutThickness</a>(<a href='undocumented#SkScalar'>SkScalar</a>* thickness) const; |
| 207 | bool <a href='#SkPaint_FontMetrics_hasStrikeoutPosition'>hasStrikeoutPosition</a>(<a href='undocumented#SkScalar'>SkScalar</a>* position) const; |
| 208 | }; |
| 209 | |
| 210 | <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; |
| 211 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_getFontSpacing'>getFontSpacing</a>() const; |
| 212 | int <a href='#SkPaint_textToGlyphs'>textToGlyphs</a>(const void* text, size_t byteLength, |
| 213 | <a href='undocumented#SkGlyphID'>SkGlyphID</a> glyphs[]) const; |
| 214 | bool <a href='#SkPaint_containsText'>containsText</a>(const void* text, size_t byteLength) const; |
| 215 | 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; |
| 216 | int <a href='#SkPaint_countText'>countText</a>(const void* text, size_t byteLength) const; |
| 217 | <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; |
| 218 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_measureText_2'>measureText</a>(const void* text, size_t length) const; |
| 219 | size_t <a href='#SkPaint_breakText'>breakText</a>(const void* text, size_t length, <a href='undocumented#SkScalar'>SkScalar</a> maxWidth, |
| 220 | <a href='undocumented#SkScalar'>SkScalar</a>* measuredWidth = nullptr) const; |
| 221 | int <a href='#SkPaint_getTextWidths'>getTextWidths</a>(const void* text, size_t byteLength, <a href='undocumented#SkScalar'>SkScalar</a> widths[], |
| 222 | <a href='SkRect_Reference#SkRect'>SkRect</a> bounds[] = nullptr) const; |
| 223 | 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, |
| 224 | <a href='SkPath_Reference#SkPath'>SkPath</a>* path) const; |
| 225 | void <a href='#SkPaint_getPosTextPath'>getPosTextPath</a>(const void* text, size_t length, |
| 226 | const <a href='SkPoint_Reference#SkPoint'>SkPoint</a> pos[], <a href='SkPath_Reference#SkPath'>SkPath</a>* path) const; |
| 227 | 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, |
| 228 | const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
| 229 | int <a href='#SkPaint_getPosTextIntercepts'>getPosTextIntercepts</a>(const void* text, size_t length, const <a href='SkPoint_Reference#SkPoint'>SkPoint</a> pos[], |
| 230 | const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
| 231 | int <a href='#SkPaint_getPosTextHIntercepts'>getPosTextHIntercepts</a>(const void* text, size_t length, const <a href='undocumented#SkScalar'>SkScalar</a> xpos[], |
| 232 | <a href='undocumented#SkScalar'>SkScalar</a> constY, const <a href='undocumented#SkScalar'>SkScalar</a> bounds[2], <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
| 233 | 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], |
| 234 | <a href='undocumented#SkScalar'>SkScalar</a>* intervals) const; |
| 235 | <a href='SkRect_Reference#SkRect'>SkRect</a> <a href='#SkPaint_getFontBounds'>getFontBounds</a>() const; |
| 236 | bool <a href='#SkPaint_nothingToDraw'>nothingToDraw</a>() const; |
| 237 | bool <a href='#SkPaint_canComputeFastBounds'>canComputeFastBounds</a>() const; |
| 238 | 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; |
| 239 | const <a href='SkRect_Reference#SkRect'>SkRect</a>& <a href='#SkPaint_computeFastStrokeBounds'>computeFastStrokeBounds</a>(const <a href='SkRect_Reference#SkRect'>SkRect</a>& orig, |
| 240 | <a href='SkRect_Reference#SkRect'>SkRect</a>* storage) const; |
| 241 | 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, |
| 242 | <a href='#SkPaint_Style'>Style</a> style) const; |
| 243 | }; |
| 244 | </pre> |
| 245 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 246 | <a href='#Paint'>Paint</a> controls options applied when drawing and measuring. <a href='#Paint'>Paint</a> collects all |
| 247 | 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] | 248 | |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 249 | Various options apply to text, strokes and fills, and images. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 250 | |
| 251 | 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] | 252 | 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] | 253 | functionality; for instance, text size is identical to matrix scale. |
| 254 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 255 | <a href='#Paint'>Paint</a> options are rarely exclusive; each option modifies a stage of the drawing |
| 256 | 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] | 257 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 258 | <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] | 259 | algorithms that alter the drawing geometry, color, and transparency. For instance, |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 260 | <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] | 261 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 262 | 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] | 263 | 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] | 264 | <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] | 265 | <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] | 266 | is set in <a href='#Paint'>Paint</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 267 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 268 | <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] | 269 | 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] | 270 | <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] | 271 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 272 | <a name='SkPaint_empty_constructor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 273 | |
| 274 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 275 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 276 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 277 | <a href='#SkPaint'>SkPaint</a>() |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 278 | </pre> |
| 279 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 280 | Constructs <a href='#Paint'>Paint</a> with default values. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 281 | |
| 282 | | attribute | default value | |
| 283 | | --- | --- | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 284 | | <a href='#Anti_Alias'>Anti Alias</a> | false | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 285 | | <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] | 286 | | <a href='SkColor_Reference#Color'>Color</a> | <a href='SkColor_Reference#SK_ColorBLACK'>SK ColorBLACK</a> | |
| 287 | | <a href='SkColor_Reference#Alpha'>Color Alpha</a> | 255 | |
| 288 | | <a href='undocumented#Color_Filter'>Color Filter</a> | nullptr | |
| 289 | | <a href='#Dither'>Dither</a> | false | |
| 290 | | <a href='undocumented#Draw_Looper'>Draw Looper</a> | nullptr | |
| 291 | | <a href='#Fake_Bold'>Fake Bold</a> | false | |
| 292 | | <a href='undocumented#Filter_Quality'>Filter Quality</a> | <a href='undocumented#kNone_SkFilterQuality'>kNone_SkFilterQuality</a> | |
| 293 | | <a href='#Font_Embedded_Bitmaps'>Font Embedded Bitmaps</a> | false | |
| 294 | | <a href='#Automatic_Hinting'>Automatic Hinting</a> | false | |
| 295 | | <a href='#Full_Hinting_Spacing'>Full Hinting Spacing</a> | false | |
| 296 | | <a href='#SkPaint_Hinting'>Hinting</a> | <a href='#SkPaint_kNormal_Hinting'>kNormal Hinting</a> | |
| 297 | | <a href='undocumented#Image_Filter'>Image Filter</a> | nullptr | |
| 298 | | <a href='#LCD_Text'>LCD Text</a> | false | |
| 299 | | <a href='#Linear_Text'>Linear Text</a> | false | |
| 300 | | <a href='#Miter_Limit'>Miter Limit</a> | 4 | |
| 301 | | <a href='undocumented#Mask_Filter'>Mask Filter</a> | nullptr | |
| 302 | | <a href='undocumented#Path_Effect'>Path Effect</a> | nullptr | |
| 303 | | <a href='undocumented#Shader'>Shader</a> | nullptr | |
| 304 | | <a href='#SkPaint_Style'>Style</a> | <a href='#SkPaint_kFill_Style'>kFill Style</a> | |
| 305 | | <a href='#Text_Align'>Text Align</a> | <a href='#SkPaint_kLeft_Align'>kLeft Align</a> | |
| 306 | | <a href='#Text_Encoding'>Text Encoding</a> | <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8 TextEncoding</a> | |
| 307 | | <a href='#Text_Scale_X'>Text Scale X</a> | 1 | |
| 308 | | <a href='#Text_Size'>Text Size</a> | 12 | |
| 309 | | <a href='#Text_Skew_X'>Text Skew X</a> | 0 | |
| 310 | | <a href='undocumented#Typeface'>Typeface</a> | nullptr | |
| 311 | | <a href='#Stroke_Cap'>Stroke Cap</a> | <a href='#SkPaint_kButt_Cap'>kButt Cap</a> | |
| 312 | | <a href='#Stroke_Join'>Stroke Join</a> | <a href='#SkPaint_kMiter_Join'>kMiter Join</a> | |
| 313 | | <a href='#Stroke_Width'>Stroke Width</a> | 0 | |
| 314 | | <a href='#Subpixel_Text'>Subpixel Text</a> | false | |
| 315 | | <a href='#Vertical_Text'>Vertical Text</a> | false | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 316 | |
| 317 | 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] | 318 | 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] | 319 | build system. |
| 320 | |
| 321 | ### Return Value |
| 322 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 323 | default initialized <a href='#Paint'>Paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 324 | |
| 325 | ### Example |
| 326 | |
| 327 | <div><fiddle-embed name="c4b2186d85c142a481298f7144295ffd"></fiddle-embed></div> |
| 328 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 329 | <a name='SkPaint_copy_const_SkPaint'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 330 | |
| 331 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 332 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 333 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 334 | <a href='#SkPaint'>SkPaint</a>(const <a href='#SkPaint'>SkPaint</a>& paint) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 335 | </pre> |
| 336 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 337 | 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>, |
| 338 | <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 |
| 339 | 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] | 340 | their references by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 341 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 342 | 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>, |
| 343 | <a href='undocumented#Draw_Looper'>Draw Looper</a>, and <a href='undocumented#Image_Filter'>Image Filter</a> cannot be modified after they are created. |
| 344 | 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] | 345 | |
| 346 | ### Parameters |
| 347 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 348 | <table> <tr> <td><a name='SkPaint_copy_const_SkPaint_paint'><code><strong>paint</strong></code></a></td> |
| 349 | <td>original to copy</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 350 | </tr> |
| 351 | </table> |
| 352 | |
| 353 | ### Return Value |
| 354 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 355 | shallow copy of <a href='#SkPaint_copy_const_SkPaint_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 356 | |
| 357 | ### Example |
| 358 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 359 | <div><fiddle-embed name="b99971ad0ef243d617925289d963b62d"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 360 | |
| 361 | #### Example Output |
| 362 | |
| 363 | ~~~~ |
| 364 | SK_ColorRED == paint1.getColor() |
| 365 | SK_ColorBLUE == paint2.getColor() |
| 366 | ~~~~ |
| 367 | |
| 368 | </fiddle-embed></div> |
| 369 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 370 | <a name='SkPaint_move_SkPaint'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 371 | |
| 372 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 373 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 374 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 375 | <a href='#SkPaint'>SkPaint</a>(<a href='#SkPaint'>SkPaint</a>&& paint) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 376 | </pre> |
| 377 | |
Cary Clark | d0530ba | 2017-09-14 11:25:39 -0400 | [diff] [blame] | 378 | Implements a move constructor to avoid increasing the reference counts |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 379 | 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] | 380 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 381 | 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] | 382 | |
| 383 | ### Parameters |
| 384 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 385 | <table> <tr> <td><a name='SkPaint_move_SkPaint_paint'><code><strong>paint</strong></code></a></td> |
| 386 | <td>original to move</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 387 | </tr> |
| 388 | </table> |
| 389 | |
| 390 | ### Return Value |
| 391 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 392 | content of <a href='#SkPaint_move_SkPaint_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 393 | |
| 394 | ### Example |
| 395 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 396 | <div><fiddle-embed name="8ed1488a503cd5282b86a51614aa90b1"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 397 | |
| 398 | #### Example Output |
| 399 | |
| 400 | ~~~~ |
| 401 | path effect unique: true |
| 402 | ~~~~ |
| 403 | |
| 404 | </fiddle-embed></div> |
| 405 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 406 | <a name='SkPaint_reset'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 407 | |
| 408 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 409 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 410 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 411 | void <a href='#SkPaint_reset'>reset</a>() |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 412 | </pre> |
| 413 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 414 | Sets all <a href='#Paint'>Paint</a> contents to their initial values. This is equivalent to replacing |
| 415 | <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] | 416 | |
| 417 | ### Example |
| 418 | |
| 419 | <div><fiddle-embed name="ef269937ade7e7353635121d9a64f9f7"> |
| 420 | |
| 421 | #### Example Output |
| 422 | |
| 423 | ~~~~ |
| 424 | paint1 == paint2 |
| 425 | ~~~~ |
| 426 | |
| 427 | </fiddle-embed></div> |
| 428 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 429 | <a name='SkPaint_destructor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 430 | |
| 431 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 432 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 433 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 434 | <a href='#SkPaint_destructor'>~SkPaint</a>() |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 435 | </pre> |
| 436 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 437 | 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>, |
| 438 | <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 |
| 439 | 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] | 440 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 441 | <a name='Management'></a> |
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 | <a name='SkPaint_copy_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 444 | |
| 445 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 446 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 447 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 448 | <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] | 449 | </pre> |
| 450 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 451 | 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>, |
| 452 | <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 |
| 453 | 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] | 454 | 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] | 455 | 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> |
| 456 | 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] | 457 | |
| 458 | ### Parameters |
| 459 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 460 | <table> <tr> <td><a name='SkPaint_copy_operator_paint'><code><strong>paint</strong></code></a></td> |
| 461 | <td>original to copy</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 462 | </tr> |
| 463 | </table> |
| 464 | |
| 465 | ### Return Value |
| 466 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 467 | content of <a href='#SkPaint_copy_operator_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 468 | |
| 469 | ### Example |
| 470 | |
| 471 | <div><fiddle-embed name="b476a9088f80dece176ed577807d3992"> |
| 472 | |
| 473 | #### Example Output |
| 474 | |
| 475 | ~~~~ |
| 476 | SK_ColorRED == paint1.getColor() |
| 477 | SK_ColorRED == paint2.getColor() |
| 478 | ~~~~ |
| 479 | |
| 480 | </fiddle-embed></div> |
| 481 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 482 | <a name='SkPaint_move_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 483 | |
| 484 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 485 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 486 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 487 | <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] | 488 | </pre> |
| 489 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 490 | Moves the <a href='#SkPaint_move_operator_paint'>paint</a> to avoid increasing the reference counts |
| 491 | 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] | 492 | prior destination are decreased by one; those objects are deleted if the resulting count |
| 493 | is zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 494 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 495 | 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] | 496 | |
| 497 | ### Parameters |
| 498 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 499 | <table> <tr> <td><a name='SkPaint_move_operator_paint'><code><strong>paint</strong></code></a></td> |
| 500 | <td>original to move</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 501 | </tr> |
| 502 | </table> |
| 503 | |
| 504 | ### Return Value |
| 505 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 506 | content of <a href='#SkPaint_move_operator_paint'>paint</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 507 | |
| 508 | ### Example |
| 509 | |
Ravi Mistry | 874e22b | 2018-07-19 03:49:13 +0000 | [diff] [blame] | 510 | <div><fiddle-embed name="9fb7459b097d713f5f1fe5675afe14f5"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 511 | |
| 512 | #### Example Output |
| 513 | |
| 514 | ~~~~ |
| 515 | SK_ColorRED == paint2.getColor() |
| 516 | ~~~~ |
| 517 | |
| 518 | </fiddle-embed></div> |
| 519 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 520 | <a name='SkPaint_equal_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 521 | |
| 522 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 523 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 524 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 525 | 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] | 526 | </pre> |
| 527 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 528 | 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 |
| 529 | 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>, |
| 530 | <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] | 531 | |
| 532 | ### Parameters |
| 533 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 534 | <table> <tr> <td><a name='SkPaint_equal_operator_a'><code><strong>a</strong></code></a></td> |
| 535 | <td><a href='#Paint'>Paint</a> to compare</td> |
| 536 | </tr> |
| 537 | <tr> <td><a name='SkPaint_equal_operator_b'><code><strong>b</strong></code></a></td> |
| 538 | <td><a href='#Paint'>Paint</a> to compare</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 539 | </tr> |
| 540 | </table> |
| 541 | |
| 542 | ### Return Value |
| 543 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 544 | true if <a href='#Paint'>Paint</a> pair are equivalent |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 545 | |
| 546 | ### Example |
| 547 | |
| 548 | <div><fiddle-embed name="7481a948e34672720337a631830586dd"> |
| 549 | |
| 550 | #### Example Output |
| 551 | |
| 552 | ~~~~ |
| 553 | paint1 == paint2 |
| 554 | paint1 != paint2 |
| 555 | ~~~~ |
| 556 | |
| 557 | </fiddle-embed></div> |
| 558 | |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 559 | ### See Also |
| 560 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 561 | <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] | 562 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 563 | <a name='SkPaint_notequal_operator'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 564 | |
| 565 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 566 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 567 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 568 | 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] | 569 | </pre> |
| 570 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 571 | 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 |
| 572 | 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>, |
| 573 | <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] | 574 | |
| 575 | ### Parameters |
| 576 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 577 | <table> <tr> <td><a name='SkPaint_notequal_operator_a'><code><strong>a</strong></code></a></td> |
| 578 | <td><a href='#Paint'>Paint</a> to compare</td> |
| 579 | </tr> |
| 580 | <tr> <td><a name='SkPaint_notequal_operator_b'><code><strong>b</strong></code></a></td> |
| 581 | <td><a href='#Paint'>Paint</a> to compare</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 582 | </tr> |
| 583 | </table> |
| 584 | |
| 585 | ### Return Value |
| 586 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 587 | true if <a href='#Paint'>Paint</a> pair are not equivalent |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 588 | |
| 589 | ### Example |
| 590 | |
skia-bookmaker | a717ca9 | 2018-07-08 05:32:09 +0000 | [diff] [blame] | 591 | <div><fiddle-embed name="b6c8484b1187f555b435ad5369833be4"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 592 | |
| 593 | #### Example Output |
| 594 | |
| 595 | ~~~~ |
| 596 | paint1 == paint2 |
| 597 | paint1 == paint2 |
| 598 | ~~~~ |
| 599 | |
| 600 | </fiddle-embed></div> |
| 601 | |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 602 | ### See Also |
| 603 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 604 | <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] | 605 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 606 | <a name='SkPaint_getHash'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 607 | |
| 608 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 609 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 610 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 611 | uint32_t <a href='#SkPaint_getHash'>getHash</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 612 | </pre> |
| 613 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 614 | 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] | 615 | Identical hashes guarantee that the paints are |
| 616 | equivalent, but differing hashes do not guarantee that the paints have differing |
| 617 | contents. |
| 618 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 619 | 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] | 620 | their hashes are also equal. |
| 621 | |
| 622 | The hash returned is platform and implementation specific. |
| 623 | |
| 624 | ### Return Value |
| 625 | |
| 626 | a shallow hash |
| 627 | |
| 628 | ### Example |
| 629 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 630 | <div><fiddle-embed name="7f7e1b701361912b344f90ae6b530393"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 631 | |
| 632 | #### Example Output |
| 633 | |
| 634 | ~~~~ |
| 635 | paint1 == paint2 |
| 636 | paint1.getHash() == paint2.getHash() |
| 637 | ~~~~ |
| 638 | |
| 639 | </fiddle-embed></div> |
| 640 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 641 | <a name='Hinting'></a> |
| 642 | |
| 643 | <a name='SkPaint_Hinting'></a> |
| 644 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 645 | --- |
| 646 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 647 | <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] | 648 | enum <a href='#SkPaint_Hinting'>Hinting</a> { |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 649 | <a href='#SkPaint_kNo_Hinting'>kNo_Hinting</a> = 0, |
| 650 | <a href='#SkPaint_kSlight_Hinting'>kSlight_Hinting</a> = 1, |
| 651 | <a href='#SkPaint_kNormal_Hinting'>kNormal_Hinting</a> = 2, |
| 652 | <a href='#SkPaint_kFull_Hinting'>kFull_Hinting</a> = 3, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 653 | }; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 654 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 655 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 656 | <a href='#SkPaint_Hinting'>Hinting</a> adjusts the glyph outlines so that the shape provides a uniform |
| 657 | 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] | 658 | muted effect or no effect at all depending on the platform. |
| 659 | |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 660 | The four levels roughly control corresponding features on platforms that use FreeType |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 661 | as the <a href='undocumented#Engine'>Font Engine</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 662 | |
| 663 | ### Constants |
| 664 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 665 | <table style='border-collapse: collapse; width: 62.5em'> |
| 666 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 667 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 668 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 669 | <tr style='background-color: #f0f0f0; '> |
| 670 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kNo_Hinting'><code>SkPaint::kNo_Hinting</code></a></td> |
| 671 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 672 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 673 | Leaves glyph outlines unchanged from their native representation. |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 674 | With FreeType, this is equivalent to the FT_LOAD_NO_HINTING |
| 675 | 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] | 676 | 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] | 677 | to 26.6 fractional pixels. |
| 678 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 679 | </tr> |
| 680 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 681 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kSlight_Hinting'><code>SkPaint::kSlight_Hinting</code></a></td> |
| 682 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 683 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 684 | Modifies glyph outlines minimally to improve constrast. |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 685 | With FreeType, this is equivalent in spirit to the |
| 686 | 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] | 687 | lighter hinting algorithm for non-monochrome modes. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 688 | 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] | 689 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 690 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 691 | <tr style='background-color: #f0f0f0; '> |
| 692 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kNormal_Hinting'><code>SkPaint::kNormal_Hinting</code></a></td> |
| 693 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 694 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 695 | Modifies glyph outlines to improve constrast. This is the default. |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 696 | With FreeType, this supplies FT_LOAD_TARGET_NORMAL to FT_Load_Glyph, |
| 697 | choosing the default hinting algorithm, which is optimized for standard |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 698 | gray-level rendering. |
| 699 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 700 | </tr> |
| 701 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 702 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kFull_Hinting'><code>SkPaint::kFull_Hinting</code></a></td> |
| 703 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 704 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 705 | Modifies glyph outlines for maximum constrast. With FreeType, this selects |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 706 | 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] | 707 | FT_LOAD_TARGET_LCD is a variant of FT_LOAD_TARGET_NORMAL optimized for |
| 708 | horizontally decimated LCD displays; FT_LOAD_TARGET_LCD_V is a |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 709 | variant of FT_LOAD_TARGET_NORMAL optimized for vertically decimated LCD displays. |
| 710 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 711 | </tr> |
| 712 | </table> |
| 713 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 714 | 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] | 715 | 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] | 716 | 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] | 717 | 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] | 718 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 719 | 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] | 720 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 721 | <a href='#SkPaint_Hinting'>Hinting</a> defaults to <a href='#SkPaint_kNormal_Hinting'>kNormal Hinting</a>. |
| 722 | 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] | 723 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 724 | <a name='SkPaint_getHinting'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 725 | |
| 726 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 727 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 728 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 729 | <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] | 730 | </pre> |
| 731 | |
| 732 | Returns level of glyph outline adjustment. |
| 733 | |
| 734 | ### Return Value |
| 735 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 736 | 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] | 737 | |
| 738 | ### Example |
| 739 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 740 | <div><fiddle-embed name="329e2e5a5919ac431e1c58878a5b99e0"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 741 | |
| 742 | #### Example Output |
| 743 | |
| 744 | ~~~~ |
| 745 | SkPaint::kNormal_Hinting == paint.getHinting() |
| 746 | ~~~~ |
| 747 | |
| 748 | </fiddle-embed></div> |
| 749 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 750 | <a name='SkPaint_setHinting'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 751 | |
| 752 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 753 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 754 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 755 | 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] | 756 | </pre> |
| 757 | |
| 758 | Sets level of glyph outline adjustment. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 759 | 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] | 760 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 761 | | <a href='#SkPaint_Hinting'>Hinting</a> | value | effect on generated glyph outlines | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 762 | | --- | --- | --- | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 763 | | <a href='#SkPaint_kNo_Hinting'>kNo Hinting</a> | 0 | leaves glyph outlines unchanged from their native representation | |
| 764 | | <a href='#SkPaint_kSlight_Hinting'>kSlight Hinting</a> | 1 | modifies glyph outlines minimally to improve contrast | |
| 765 | | <a href='#SkPaint_kNormal_Hinting'>kNormal Hinting</a> | 2 | modifies glyph outlines to improve contrast | |
| 766 | | <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] | 767 | |
| 768 | ### Parameters |
| 769 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 770 | <table> <tr> <td><a name='SkPaint_setHinting_hintingLevel'><code><strong>hintingLevel</strong></code></a></td> |
| 771 | <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] | 772 | </tr> |
| 773 | </table> |
| 774 | |
| 775 | ### Example |
| 776 | |
| 777 | <div><fiddle-embed name="78153fbd3f1000cb33b97bbe831ed34e"> |
| 778 | |
| 779 | #### Example Output |
| 780 | |
| 781 | ~~~~ |
| 782 | paint1 == paint2 |
| 783 | ~~~~ |
| 784 | |
| 785 | </fiddle-embed></div> |
| 786 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 787 | <a name='Flags'></a> |
| 788 | |
| 789 | <a name='SkPaint_Flags'></a> |
| 790 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 791 | --- |
| 792 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 793 | <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] | 794 | enum <a href='#SkPaint_Flags'>Flags</a> { |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 795 | <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias_Flag</a> = 0x01, |
| 796 | <a href='#SkPaint_kDither_Flag'>kDither_Flag</a> = 0x04, |
| 797 | <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText_Flag</a> = 0x20, |
| 798 | <a href='#SkPaint_kLinearText_Flag'>kLinearText_Flag</a> = 0x40, |
| 799 | <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText_Flag</a> = 0x80, |
| 800 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText_Flag</a> = 0x200, |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 801 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText_Flag</a> = 0x400, |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 802 | <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting_Flag</a> = 0x800, |
| 803 | <a href='#SkPaint_kVerticalText_Flag'>kVerticalText_Flag</a> = 0x1000, |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 804 | <a href='#SkPaint_kAllFlags'>kAllFlags</a> = 0xFFFF, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 805 | }; |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 806 | </pre> |
| 807 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 808 | The bit values stored in <a href='#SkPaint_Flags'>Flags</a>. |
| 809 | The default value for <a href='#SkPaint_Flags'>Flags</a>, normally zero, can be changed at compile time |
| 810 | with a custom definition of <a href='undocumented#SkPaintDefaults_Flags'>SkPaintDefaults Flags</a>. |
| 811 | 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] | 812 | multiple settings at once. |
| 813 | |
| 814 | ### Constants |
| 815 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 816 | <table style='border-collapse: collapse; width: 62.5em'> |
| 817 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 818 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 819 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 820 | <tr style='background-color: #f0f0f0; '> |
| 821 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAntiAlias_Flag'><code>SkPaint::kAntiAlias_Flag</code></a></td> |
| 822 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0001</td> |
| 823 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 824 | mask for setting Anti_Alias</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 825 | </tr> |
| 826 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 827 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kDither_Flag'><code>SkPaint::kDither_Flag</code></a></td> |
| 828 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0004</td> |
| 829 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 830 | mask for setting Dither</td> |
| 831 | </tr> |
| 832 | <tr style='background-color: #f0f0f0; '> |
| 833 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kFakeBoldText_Flag'><code>SkPaint::kFakeBoldText_Flag</code></a></td> |
| 834 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0020</td> |
| 835 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 836 | mask for setting Fake_Bold</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 837 | </tr> |
| 838 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 839 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLinearText_Flag'><code>SkPaint::kLinearText_Flag</code></a></td> |
| 840 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0040</td> |
| 841 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 842 | mask for setting Linear_Text</td> |
| 843 | </tr> |
| 844 | <tr style='background-color: #f0f0f0; '> |
| 845 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kSubpixelText_Flag'><code>SkPaint::kSubpixelText_Flag</code></a></td> |
| 846 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0080</td> |
| 847 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 848 | mask for setting Subpixel_Text</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 849 | </tr> |
| 850 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 851 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLCDRenderText_Flag'><code>SkPaint::kLCDRenderText_Flag</code></a></td> |
| 852 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0200</td> |
| 853 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 854 | mask for setting LCD_Text</td> |
| 855 | </tr> |
| 856 | <tr style='background-color: #f0f0f0; '> |
| 857 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kEmbeddedBitmapText_Flag'><code>SkPaint::kEmbeddedBitmapText_Flag</code></a></td> |
| 858 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0400</td> |
| 859 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 860 | mask for setting Font_Embedded_Bitmaps</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 861 | </tr> |
| 862 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 863 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAutoHinting_Flag'><code>SkPaint::kAutoHinting_Flag</code></a></td> |
| 864 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0800</td> |
| 865 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 866 | mask for setting Automatic_Hinting</td> |
| 867 | </tr> |
| 868 | <tr style='background-color: #f0f0f0; '> |
| 869 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kVerticalText_Flag'><code>SkPaint::kVerticalText_Flag</code></a></td> |
| 870 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x1000</td> |
| 871 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 872 | mask for setting Vertical_Text</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 873 | </tr> |
| 874 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 875 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAllFlags'><code>SkPaint::kAllFlags</code></a></td> |
| 876 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0xFFFF</td> |
| 877 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 878 | 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] | 879 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 880 | <a href='#SkPaint_Flags'>Flags</a> default to all flags clear, disabling the associated feature. |
| 881 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 882 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 883 | <a name='SkPaint_ReserveFlags'></a> |
| 884 | |
| 885 | --- |
Cary Clark | 06c20f3 | 2018-03-20 15:53:27 -0400 | [diff] [blame] | 886 | |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 887 | To be deprecated soon. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 888 | |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 889 | Only valid for Android framework. |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 890 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 891 | <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] | 892 | enum <a href='#SkPaint_ReserveFlags'>ReserveFlags</a> { |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 893 | <a href='#SkPaint_kUnderlineText_ReserveFlag'>kUnderlineText_ReserveFlag</a> = 0x08, |
| 894 | <a href='#SkPaint_kStrikeThruText_ReserveFlag'>kStrikeThruText_ReserveFlag</a> = 0x10, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 895 | }; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 896 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 897 | |
| 898 | ### Constants |
| 899 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 900 | <table style='border-collapse: collapse; width: 62.5em'> |
| 901 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 902 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 903 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 904 | <tr style='background-color: #f0f0f0; '> |
| 905 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kUnderlineText_ReserveFlag'><code>SkPaint::kUnderlineText_ReserveFlag</code></a></td> |
| 906 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0008</td> |
| 907 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 908 | To be deprecated soon. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 909 | |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 910 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 911 | </tr> |
| 912 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 913 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStrikeThruText_ReserveFlag'><code>SkPaint::kStrikeThruText_ReserveFlag</code></a></td> |
| 914 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0010</td> |
| 915 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 916 | To be deprecated soon. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 917 | |
Cary Clark | e8161dd | 2018-09-06 12:47:04 -0400 | [diff] [blame] | 918 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 919 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 920 | </table> |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 921 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 922 | <a name='SkPaint_getFlags'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 923 | |
| 924 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 925 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 926 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 927 | uint32_t <a href='#SkPaint_getFlags'>getFlags</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 928 | </pre> |
| 929 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 930 | Returns paint settings described by <a href='#SkPaint_Flags'>Flags</a>. Each setting uses one |
| 931 | 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] | 932 | |
| 933 | ### Return Value |
| 934 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 935 | 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] | 936 | |
| 937 | ### Example |
| 938 | |
| 939 | <div><fiddle-embed name="8a3f8c309533388b01aa66e1267f322d"> |
| 940 | |
| 941 | #### Example Output |
| 942 | |
| 943 | ~~~~ |
| 944 | (SkPaint::kAntiAlias_Flag & paint.getFlags()) != 0 |
| 945 | ~~~~ |
| 946 | |
| 947 | </fiddle-embed></div> |
| 948 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 949 | <a name='SkPaint_setFlags'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 950 | |
| 951 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 952 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 953 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 954 | void <a href='#SkPaint_setFlags'>setFlags</a>(uint32_t flags) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 955 | </pre> |
| 956 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 957 | 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. |
| 958 | 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] | 959 | |
| 960 | ### Parameters |
| 961 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 962 | <table> <tr> <td><a name='SkPaint_setFlags_flags'><code><strong>flags</strong></code></a></td> |
| 963 | <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] | 964 | </tr> |
| 965 | </table> |
| 966 | |
| 967 | ### Example |
| 968 | |
| 969 | <div><fiddle-embed name="54baed3f6bc4b9c31ba664e27767fdc7"> |
| 970 | |
| 971 | #### Example Output |
| 972 | |
| 973 | ~~~~ |
| 974 | paint.isAntiAlias() |
| 975 | paint.isDither() |
| 976 | ~~~~ |
| 977 | |
| 978 | </fiddle-embed></div> |
| 979 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 980 | <a name='Anti_Alias'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 981 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 982 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 983 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 984 | <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] | 985 | If <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias Flag</a> is clear, pixel centers contained by the shape edge are drawn opaque. |
| 986 | 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] | 987 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 988 | 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] | 989 | passing through the pixel center may, but is not required to, draw the pixel. |
| 990 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 991 | <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 |
| 992 | 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] | 993 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 994 | A platform may only support <a href='#Anti_Alias'>Anti Aliased</a> drawing. Some GPU-backed platforms use |
| 995 | <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] | 996 | <a href='undocumented#Alias'>Alias</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 997 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 998 | 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] | 999 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1000 | <a href='#Anti_Alias'>Anti Alias</a> is disabled by default. |
| 1001 | <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] | 1002 | at compile time. |
| 1003 | |
| 1004 | ### Example |
| 1005 | |
| 1006 | <div><fiddle-embed name="a6575a49467ce8d28bb01cc7638fa04d"><div>A red line is drawn with transparency on the edges to make it look smoother. |
| 1007 | A blue line draws only where the pixel centers are contained. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1008 | The lines are drawn into <a href='SkBitmap_Reference#Bitmap'>Bitmap</a>, then drawn magnified to make the |
| 1009 | <a href='undocumented#Alias'>Aliasing</a> easier to see. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 1010 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1011 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1012 | <a name='SkPaint_isAntiAlias'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1013 | |
| 1014 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1015 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1016 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1017 | bool <a href='#SkPaint_isAntiAlias'>isAntiAlias</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1018 | </pre> |
| 1019 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1020 | 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] | 1021 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1022 | 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] | 1023 | |
| 1024 | ### Return Value |
| 1025 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1026 | <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1027 | |
| 1028 | ### Example |
| 1029 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 1030 | <div><fiddle-embed name="d7d5f4f7da7acd5104a652f490c6f7b8"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1031 | |
| 1032 | #### Example Output |
| 1033 | |
| 1034 | ~~~~ |
| 1035 | paint.isAntiAlias() == !!(paint.getFlags() & SkPaint::kAntiAlias_Flag) |
| 1036 | paint.isAntiAlias() == !!(paint.getFlags() & SkPaint::kAntiAlias_Flag) |
| 1037 | ~~~~ |
| 1038 | |
| 1039 | </fiddle-embed></div> |
| 1040 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1041 | <a name='SkPaint_setAntiAlias'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1042 | |
| 1043 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1044 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1045 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1046 | void <a href='#SkPaint_setAntiAlias'>setAntiAlias</a>(bool aa) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1047 | </pre> |
| 1048 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1049 | 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] | 1050 | partial transparency. |
| 1051 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1052 | Sets <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias Flag</a> if <a href='#SkPaint_setAntiAlias_aa'>aa</a> is true. |
| 1053 | 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] | 1054 | |
| 1055 | ### Parameters |
| 1056 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1057 | <table> <tr> <td><a name='SkPaint_setAntiAlias_aa'><code><strong>aa</strong></code></a></td> |
| 1058 | <td>setting for <a href='#SkPaint_kAntiAlias_Flag'>kAntiAlias Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1059 | </tr> |
| 1060 | </table> |
| 1061 | |
| 1062 | ### Example |
| 1063 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 1064 | <div><fiddle-embed name="c2ff148374d01cbef845b223e725905c"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1065 | |
| 1066 | #### Example Output |
| 1067 | |
| 1068 | ~~~~ |
| 1069 | paint1 == paint2 |
| 1070 | ~~~~ |
| 1071 | |
| 1072 | </fiddle-embed></div> |
| 1073 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1074 | <a name='Dither'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1075 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1076 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1077 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1078 | <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] | 1079 | This can help to smooth color transitions and reducing banding in gradients. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1080 | Dithering lessens visible banding from <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> |
| 1081 | and <a href='SkImageInfo_Reference#kRGBA_8888_SkColorType'>kRGBA_8888_SkColorType</a> gradients, |
| 1082 | 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] | 1083 | |
| 1084 | Dithering is always enabled for linear gradients drawing into |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1085 | <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>. |
| 1086 | <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 |
| 1087 | <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] | 1088 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1089 | <a href='#Dither'>Dither</a> is disabled by default. |
| 1090 | <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] | 1091 | at compile time. |
| 1092 | |
Cary Clark | 2be81cf | 2018-09-13 12:04:30 -0400 | [diff] [blame] | 1093 | 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] | 1094 | |
| 1095 | ### Example |
| 1096 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 1097 | <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] | 1098 | alternating nearby colors from pixel to pixel. |
| 1099 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1100 | |
| 1101 | ### Example |
| 1102 | |
Cary Clark | a619d45 | 2018-07-16 08:12:01 -0400 | [diff] [blame] | 1103 | <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] | 1104 | 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] | 1105 | dither, making it easier to see. |
| 1106 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1107 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1108 | ### See Also |
| 1109 | |
| 1110 | Gradient <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> |
| 1111 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1112 | <a name='SkPaint_isDither'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1113 | |
| 1114 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1115 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1116 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1117 | bool <a href='#SkPaint_isDither'>isDither</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1118 | </pre> |
| 1119 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1120 | Returns true if color error may be distributed to smooth color transition. |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 1121 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1122 | 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] | 1123 | |
| 1124 | ### Return Value |
| 1125 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1126 | <a href='#SkPaint_kDither_Flag'>kDither Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1127 | |
| 1128 | ### Example |
| 1129 | |
| 1130 | <div><fiddle-embed name="f4ce93f6c5e7335436a985377fd980c0"> |
| 1131 | |
| 1132 | #### Example Output |
| 1133 | |
| 1134 | ~~~~ |
| 1135 | paint.isDither() == !!(paint.getFlags() & SkPaint::kDither_Flag) |
| 1136 | paint.isDither() == !!(paint.getFlags() & SkPaint::kDither_Flag) |
| 1137 | ~~~~ |
| 1138 | |
| 1139 | </fiddle-embed></div> |
| 1140 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1141 | <a name='SkPaint_setDither'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1142 | |
| 1143 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1144 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1145 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1146 | void <a href='#SkPaint_setDither'>setDither</a>(bool dither) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1147 | </pre> |
| 1148 | |
| 1149 | Requests, but does not require, to distribute color error. |
| 1150 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1151 | Sets <a href='#SkPaint_kDither_Flag'>kDither Flag</a> if <a href='#SkPaint_setDither_dither'>dither</a> is true. |
| 1152 | 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] | 1153 | |
| 1154 | ### Parameters |
| 1155 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1156 | <table> <tr> <td><a name='SkPaint_setDither_dither'><code><strong>dither</strong></code></a></td> |
| 1157 | <td>setting for <a href='#SkPaint_kDither_Flag'>kDither Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1158 | </tr> |
| 1159 | </table> |
| 1160 | |
| 1161 | ### Example |
| 1162 | |
| 1163 | <div><fiddle-embed name="69b7162e8324d9239dd02dd9ada2bdff"> |
| 1164 | |
| 1165 | #### Example Output |
| 1166 | |
| 1167 | ~~~~ |
| 1168 | paint1 == paint2 |
| 1169 | ~~~~ |
| 1170 | |
| 1171 | </fiddle-embed></div> |
| 1172 | |
| 1173 | ### See Also |
| 1174 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1175 | <a href='SkImageInfo_Reference#kRGB_565_SkColorType'>kRGB_565_SkColorType</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1176 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1177 | <a name='Device_Text'></a> |
| 1178 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1179 | --- |
| 1180 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1181 | <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] | 1182 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1183 | 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] | 1184 | create a color, and relies |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1185 | 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] | 1186 | <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] | 1187 | the color components as RGB or BGR. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1188 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1189 | <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] | 1190 | As the opaqueness |
| 1191 | of the color increases, the edge of the glyph appears to move towards the outside of the pixel. |
| 1192 | |
| 1193 | Either or both techniques can be enabled. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1194 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText Flag</a> and <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText Flag</a> are clear by default. |
| 1195 | <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 |
| 1196 | <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] | 1197 | |
| 1198 | ### Example |
| 1199 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1200 | <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>. |
| 1201 | When <a href='#Subpixel_Text'>Subpixel Text</a> is disabled, the comma <a href='undocumented#Glyph'>Glyphs</a> are identical, but not evenly spaced. |
| 1202 | 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] | 1203 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1204 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1205 | <a name='Linear_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1206 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1207 | <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>. |
| 1208 | 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>. |
| 1209 | 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] | 1210 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1211 | <a name='SkPaint_isLinearText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1212 | |
| 1213 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1214 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1215 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1216 | bool <a href='#SkPaint_isLinearText'>isLinearText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1217 | </pre> |
| 1218 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1219 | 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] | 1220 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1221 | 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] | 1222 | |
| 1223 | ### Return Value |
| 1224 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1225 | <a href='#SkPaint_kLinearText_Flag'>kLinearText Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1226 | |
| 1227 | ### Example |
| 1228 | |
| 1229 | <div><fiddle-embed name="2890ad644f980637837e6fcb386fb462"></fiddle-embed></div> |
| 1230 | |
| 1231 | ### See Also |
| 1232 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1233 | <a href='#SkPaint_setLinearText'>setLinearText</a> <a href='#SkPaint_Hinting'>Hinting</a> |
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 | <a name='SkPaint_setLinearText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1236 | |
| 1237 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1238 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1239 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1240 | void <a href='#SkPaint_setLinearText'>setLinearText</a>(bool linearText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1241 | </pre> |
| 1242 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1243 | 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] | 1244 | By default, <a href='#SkPaint_kLinearText_Flag'>kLinearText Flag</a> is clear. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1245 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1246 | Sets <a href='#SkPaint_kLinearText_Flag'>kLinearText Flag</a> if <a href='#SkPaint_setLinearText_linearText'>linearText</a> is true. |
| 1247 | 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] | 1248 | |
| 1249 | ### Parameters |
| 1250 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1251 | <table> <tr> <td><a name='SkPaint_setLinearText_linearText'><code><strong>linearText</strong></code></a></td> |
| 1252 | <td>setting for <a href='#SkPaint_kLinearText_Flag'>kLinearText Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1253 | </tr> |
| 1254 | </table> |
| 1255 | |
| 1256 | ### Example |
| 1257 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 1258 | <div><fiddle-embed name="c93bb912f3bddfb4d96d3ad70ada552b"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1259 | |
| 1260 | ### See Also |
| 1261 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1262 | <a href='#SkPaint_isLinearText'>isLinearText</a> <a href='#SkPaint_Hinting'>Hinting</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1263 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1264 | <a name='Subpixel_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1265 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1266 | <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] | 1267 | As the opaqueness |
| 1268 | of the color increases, the edge of the glyph appears to move towards the outside of the pixel. |
| 1269 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1270 | <a name='SkPaint_isSubpixelText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1271 | |
| 1272 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1273 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1274 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1275 | bool <a href='#SkPaint_isSubpixelText'>isSubpixelText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1276 | </pre> |
| 1277 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1278 | 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] | 1279 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1280 | 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] | 1281 | |
| 1282 | ### Return Value |
| 1283 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1284 | <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1285 | |
| 1286 | ### Example |
| 1287 | |
| 1288 | <div><fiddle-embed name="abe9afc0932e2199324ae6cbb396e67c"> |
| 1289 | |
| 1290 | #### Example Output |
| 1291 | |
| 1292 | ~~~~ |
| 1293 | paint.isSubpixelText() == !!(paint.getFlags() & SkPaint::kSubpixelText_Flag) |
| 1294 | paint.isSubpixelText() == !!(paint.getFlags() & SkPaint::kSubpixelText_Flag) |
| 1295 | ~~~~ |
| 1296 | |
| 1297 | </fiddle-embed></div> |
| 1298 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1299 | <a name='SkPaint_setSubpixelText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1300 | |
| 1301 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1302 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1303 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1304 | void <a href='#SkPaint_setSubpixelText'>setSubpixelText</a>(bool subpixelText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1305 | </pre> |
| 1306 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1307 | 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] | 1308 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1309 | Sets <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText Flag</a> if <a href='#SkPaint_setSubpixelText_subpixelText'>subpixelText</a> is true. |
| 1310 | 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] | 1311 | |
| 1312 | ### Parameters |
| 1313 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1314 | <table> <tr> <td><a name='SkPaint_setSubpixelText_subpixelText'><code><strong>subpixelText</strong></code></a></td> |
| 1315 | <td>setting for <a href='#SkPaint_kSubpixelText_Flag'>kSubpixelText Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1316 | </tr> |
| 1317 | </table> |
| 1318 | |
| 1319 | ### Example |
| 1320 | |
| 1321 | <div><fiddle-embed name="a77bbc1a4e3be9a8ab0f842f877c5ee4"> |
| 1322 | |
| 1323 | #### Example Output |
| 1324 | |
| 1325 | ~~~~ |
| 1326 | paint1 == paint2 |
| 1327 | ~~~~ |
| 1328 | |
| 1329 | </fiddle-embed></div> |
| 1330 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1331 | <a name='LCD_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1332 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1333 | 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] | 1334 | create a color, and relies |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1335 | 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] | 1336 | <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] | 1337 | the color components as RGB or BGR. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1338 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1339 | <a name='SkPaint_isLCDRenderText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1340 | |
| 1341 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1342 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1343 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1344 | bool <a href='#SkPaint_isLCDRenderText'>isLCDRenderText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1345 | </pre> |
| 1346 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1347 | 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] | 1348 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1349 | 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] | 1350 | |
| 1351 | ### Return Value |
| 1352 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1353 | <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1354 | |
| 1355 | ### Example |
| 1356 | |
skia-bookmaker | a391c72 | 2018-07-09 05:28:19 +0000 | [diff] [blame] | 1357 | <div><fiddle-embed name="68e1fd95dd2fd06a333899d2bd2396b9"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1358 | |
| 1359 | #### Example Output |
| 1360 | |
| 1361 | ~~~~ |
| 1362 | paint.isLCDRenderText() == !!(paint.getFlags() & SkPaint::kLCDRenderText_Flag) |
| 1363 | paint.isLCDRenderText() == !!(paint.getFlags() & SkPaint::kLCDRenderText_Flag) |
| 1364 | ~~~~ |
| 1365 | |
| 1366 | </fiddle-embed></div> |
| 1367 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1368 | <a name='SkPaint_setLCDRenderText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1369 | |
| 1370 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1371 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1372 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1373 | void <a href='#SkPaint_setLCDRenderText'>setLCDRenderText</a>(bool lcdText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1374 | </pre> |
| 1375 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1376 | 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] | 1377 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1378 | Sets <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText Flag</a> if <a href='#SkPaint_setLCDRenderText_lcdText'>lcdText</a> is true. |
| 1379 | 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] | 1380 | |
| 1381 | ### Parameters |
| 1382 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1383 | <table> <tr> <td><a name='SkPaint_setLCDRenderText_lcdText'><code><strong>lcdText</strong></code></a></td> |
| 1384 | <td>setting for <a href='#SkPaint_kLCDRenderText_Flag'>kLCDRenderText Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1385 | </tr> |
| 1386 | </table> |
| 1387 | |
| 1388 | ### Example |
| 1389 | |
skia-bookmaker | e0a458f | 2018-07-16 05:29:00 +0000 | [diff] [blame] | 1390 | <div><fiddle-embed name="50dedf8450159571a3edaf4f0050defe"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1391 | |
| 1392 | #### Example Output |
| 1393 | |
| 1394 | ~~~~ |
| 1395 | paint1 == paint2 |
| 1396 | ~~~~ |
| 1397 | |
| 1398 | </fiddle-embed></div> |
| 1399 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1400 | <a name='Font_Embedded_Bitmaps'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1401 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1402 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1403 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1404 | <a href='#Font_Embedded_Bitmaps'>Font Embedded Bitmaps</a> allows selecting custom sized bitmap <a href='undocumented#Glyph'>Glyphs</a>. |
| 1405 | <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] | 1406 | in a font if the platform supports this option. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1407 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1408 | FreeType selects the bitmap glyph if available when <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText Flag</a> is set, and selects |
| 1409 | 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] | 1410 | 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] | 1411 | <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] | 1412 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1413 | <a href='#Font_Embedded_Bitmaps'>Font Embedded Bitmaps</a> is disabled by default. |
| 1414 | <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 |
| 1415 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText Flag</a> at compile time. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1416 | |
| 1417 | ### Example |
| 1418 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1419 | <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] | 1420 | <div>The "hintgasp" TrueType font in the Skia resources/fonts directory |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1421 | includes an embedded bitmap Glyph at odd font sizes. This example works |
| 1422 | on platforms that use FreeType as their Font_Engine. |
| 1423 | Windows may, but is not required to, return a bitmap glyph if |
| 1424 | kEmbeddedBitmapText_Flag is set.</div>SkBitmap bitmap; |
| 1425 | bitmap.allocN32Pixels(30, 15); |
| 1426 | bitmap.eraseColor(0); |
| 1427 | SkCanvas offscreen(bitmap); |
| 1428 | SkPaint paint; |
| 1429 | paint.setAntiAlias(true); |
| 1430 | paint.setTextSize(13); |
Hal Canary | 53e5e7d | 2017-12-08 14:25:14 -0500 | [diff] [blame] | 1431 | paint.setTypeface(MakeResourceAsTypeface("fonts/hintgasp.ttf")); |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1432 | for (bool embedded : { false, true}) { |
| 1433 | paint.setEmbeddedBitmapText(embedded); |
| 1434 | offscreen.drawString("A", embedded ? 5 : 15, 15, paint); |
| 1435 | } |
| 1436 | canvas->drawBitmap(bitmap, 0, 0); |
| 1437 | canvas->scale(10, 10); |
| 1438 | canvas->drawBitmap(bitmap, -2, 1); |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 1439 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1440 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1441 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1442 | <a name='SkPaint_isEmbeddedBitmapText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1443 | |
| 1444 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1445 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1446 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1447 | bool <a href='#SkPaint_isEmbeddedBitmapText'>isEmbeddedBitmapText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1448 | </pre> |
| 1449 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1450 | 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] | 1451 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1452 | 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] | 1453 | |
| 1454 | ### Return Value |
| 1455 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1456 | <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1457 | |
| 1458 | ### Example |
| 1459 | |
| 1460 | <div><fiddle-embed name="eba10b27b790e87183ae451b3fc5c4b1"> |
| 1461 | |
| 1462 | #### Example Output |
| 1463 | |
| 1464 | ~~~~ |
| 1465 | paint.isEmbeddedBitmapText() == !!(paint.getFlags() & SkPaint::kEmbeddedBitmapText_Flag) |
| 1466 | paint.isEmbeddedBitmapText() == !!(paint.getFlags() & SkPaint::kEmbeddedBitmapText_Flag) |
| 1467 | ~~~~ |
| 1468 | |
| 1469 | </fiddle-embed></div> |
| 1470 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1471 | <a name='SkPaint_setEmbeddedBitmapText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1472 | |
| 1473 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1474 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1475 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1476 | void <a href='#SkPaint_setEmbeddedBitmapText'>setEmbeddedBitmapText</a>(bool useEmbeddedBitmapText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1477 | </pre> |
| 1478 | |
| 1479 | Requests, but does not require, to use bitmaps in fonts instead of outlines. |
| 1480 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1481 | Sets <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText Flag</a> if <a href='#SkPaint_setEmbeddedBitmapText_useEmbeddedBitmapText'>useEmbeddedBitmapText</a> is true. |
| 1482 | 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] | 1483 | |
| 1484 | ### Parameters |
| 1485 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1486 | <table> <tr> <td><a name='SkPaint_setEmbeddedBitmapText_useEmbeddedBitmapText'><code><strong>useEmbeddedBitmapText</strong></code></a></td> |
| 1487 | <td>setting for <a href='#SkPaint_kEmbeddedBitmapText_Flag'>kEmbeddedBitmapText Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1488 | </tr> |
| 1489 | </table> |
| 1490 | |
| 1491 | ### Example |
| 1492 | |
| 1493 | <div><fiddle-embed name="246dffdd93a484ba4ad7ecf71198a5d4"> |
| 1494 | |
| 1495 | #### Example Output |
| 1496 | |
| 1497 | ~~~~ |
| 1498 | paint1 == paint2 |
| 1499 | ~~~~ |
| 1500 | |
| 1501 | </fiddle-embed></div> |
| 1502 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1503 | <a name='Automatic_Hinting'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1504 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1505 | 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> |
| 1506 | instructs the <a href='undocumented#Font_Manager'>Font Manager</a> to always hint <a href='undocumented#Glyph'>Glyphs</a>. |
| 1507 | <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 |
| 1508 | <a href='#SkPaint_kSlight_Hinting'>kSlight Hinting</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1509 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1510 | <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] | 1511 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1512 | <a name='SkPaint_isAutohinted'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1513 | |
| 1514 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1515 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1516 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1517 | bool <a href='#SkPaint_isAutohinted'>isAutohinted</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1518 | </pre> |
| 1519 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1520 | 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 |
| 1521 | platform uses FreeType as the <a href='undocumented#Font_Manager'>Font Manager</a>. If true, instructs |
| 1522 | 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] | 1523 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1524 | 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] | 1525 | |
| 1526 | ### Return Value |
| 1527 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1528 | <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1529 | |
| 1530 | ### Example |
| 1531 | |
| 1532 | <div><fiddle-embed name="aa4781afbe3b90e7ef56a287e5b9ce1e"> |
| 1533 | |
| 1534 | #### Example Output |
| 1535 | |
| 1536 | ~~~~ |
| 1537 | paint.isAutohinted() == !!(paint.getFlags() & SkPaint::kAutoHinting_Flag) |
| 1538 | paint.isAutohinted() == !!(paint.getFlags() & SkPaint::kAutoHinting_Flag) |
| 1539 | ~~~~ |
| 1540 | |
| 1541 | </fiddle-embed></div> |
| 1542 | |
| 1543 | ### See Also |
| 1544 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1545 | <a href='#SkPaint_setAutohinted'>setAutohinted</a> <a href='#SkPaint_Hinting'>Hinting</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1546 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1547 | <a name='SkPaint_setAutohinted'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1548 | |
| 1549 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1550 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1551 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1552 | void <a href='#SkPaint_setAutohinted'>setAutohinted</a>(bool useAutohinter) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1553 | </pre> |
| 1554 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1555 | Sets whether to always hint <a href='undocumented#Glyph'>Glyphs</a>. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1556 | 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] | 1557 | 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] | 1558 | <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 |
| 1559 | <a href='#SkPaint_kSlight_Hinting'>kSlight Hinting</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1560 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1561 | 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] | 1562 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1563 | Sets <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting Flag</a> if <a href='#SkPaint_setAutohinted_useAutohinter'>useAutohinter</a> is true. |
| 1564 | 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] | 1565 | |
| 1566 | ### Parameters |
| 1567 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1568 | <table> <tr> <td><a name='SkPaint_setAutohinted_useAutohinter'><code><strong>useAutohinter</strong></code></a></td> |
| 1569 | <td>setting for <a href='#SkPaint_kAutoHinting_Flag'>kAutoHinting Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1570 | </tr> |
| 1571 | </table> |
| 1572 | |
| 1573 | ### Example |
| 1574 | |
| 1575 | <div><fiddle-embed name="4e185306d7de9390fe8445eed0139309"></fiddle-embed></div> |
| 1576 | |
| 1577 | ### See Also |
| 1578 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1579 | <a href='#SkPaint_isAutohinted'>isAutohinted</a> <a href='#SkPaint_Hinting'>Hinting</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1580 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1581 | <a name='Vertical_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1582 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1583 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1584 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1585 | <a href='undocumented#Text'>Text</a> may be drawn by positioning each glyph, or by positioning the first glyph and |
| 1586 | using <a href='undocumented#Advance'>Font Advance</a> to position subsequent <a href='undocumented#Glyph'>Glyphs</a>. By default, each successive glyph |
| 1587 | is positioned to the right of the preceding glyph. <a href='#Vertical_Text'>Vertical Text</a> sets successive |
| 1588 | <a href='undocumented#Glyph'>Glyphs</a> to position below the preceding glyph. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1589 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1590 | Skia can translate text character codes as a series of <a href='undocumented#Glyph'>Glyphs</a>, but does not implement |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 1591 | font substitution, |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 1592 | textual substitution, line layout, or contextual spacing like <a href='undocumented#Kerning'>Kerning</a> pairs. Use |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1593 | a text shaping engine like <a href='https://harfbuzz.org/'>HarfBuzz</a></a> to translate text runs |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1594 | into glyph series. |
| 1595 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1596 | <a href='#Vertical_Text'>Vertical Text</a> is clear if text is drawn left to right or set if drawn from top to bottom. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1597 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1598 | <a href='#SkPaint_Flags'>Flags</a> <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> if clear draws text left to right. |
| 1599 | <a href='#SkPaint_Flags'>Flags</a> <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> if set draws text top to bottom. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1600 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1601 | <a href='#Vertical_Text'>Vertical Text</a> is clear by default. |
| 1602 | <a href='#Vertical_Text'>Vertical Text</a> can be set by default by setting <a href='undocumented#SkPaintDefaults_Flags'>SkPaintDefaults Flags</a> to |
| 1603 | <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> at compile time. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1604 | |
| 1605 | ### Example |
| 1606 | |
| 1607 | <div><fiddle-embed name="8df5800819311b71373d9abb669b49b8"></fiddle-embed></div> |
| 1608 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1609 | <a name='SkPaint_isVerticalText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1610 | |
| 1611 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1612 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1613 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1614 | bool <a href='#SkPaint_isVerticalText'>isVerticalText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1615 | </pre> |
| 1616 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1617 | Returns true if <a href='undocumented#Glyph'>Glyphs</a> are drawn top to bottom instead of left to right. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1618 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1619 | Equivalent to <a href='#SkPaint_getFlags'>getFlags</a> masked with <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1620 | |
| 1621 | ### Return Value |
| 1622 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1623 | <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1624 | |
| 1625 | ### Example |
| 1626 | |
| 1627 | <div><fiddle-embed name="4a269b16e644d473870ffa873396f139"> |
| 1628 | |
| 1629 | #### Example Output |
| 1630 | |
| 1631 | ~~~~ |
| 1632 | paint.isVerticalText() == !!(paint.getFlags() & SkPaint::kVerticalText_Flag) |
| 1633 | paint.isVerticalText() == !!(paint.getFlags() & SkPaint::kVerticalText_Flag) |
| 1634 | ~~~~ |
| 1635 | |
| 1636 | </fiddle-embed></div> |
| 1637 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1638 | <a name='SkPaint_setVerticalText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1639 | |
| 1640 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1641 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1642 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1643 | void <a href='#SkPaint_setVerticalText'>setVerticalText</a>(bool verticalText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1644 | </pre> |
| 1645 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1646 | Returns true if text advance positions the next glyph below the previous glyph instead of to the |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1647 | right of previous glyph. |
| 1648 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1649 | Sets <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> if vertical is true. |
| 1650 | Clears <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> if vertical is false. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1651 | |
| 1652 | ### Parameters |
| 1653 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1654 | <table> <tr> <td><a name='SkPaint_setVerticalText_verticalText'><code><strong>verticalText</strong></code></a></td> |
| 1655 | <td>setting for <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1656 | </tr> |
| 1657 | </table> |
| 1658 | |
| 1659 | ### Example |
| 1660 | |
| 1661 | <div><fiddle-embed name="6fbd7e9e1a346cb8d7f537786009c736"> |
| 1662 | |
| 1663 | #### Example Output |
| 1664 | |
| 1665 | ~~~~ |
| 1666 | paint1 == paint2 |
| 1667 | ~~~~ |
| 1668 | |
| 1669 | </fiddle-embed></div> |
| 1670 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1671 | <a name='Fake_Bold'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1672 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1673 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1674 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1675 | <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] | 1676 | 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] | 1677 | 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] | 1678 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1679 | 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] | 1680 | is not available. |
| 1681 | |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 1682 | 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] | 1683 | the font engine to create the bold <a href='undocumented#Glyph'>Glyphs</a>. Otherwise, the extra bold is computed |
| 1684 | 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] | 1685 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1686 | <a href='#Fake_Bold'>Fake Bold</a> is disabled by default. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1687 | |
| 1688 | ### Example |
| 1689 | |
| 1690 | <div><fiddle-embed name="e811f4829a2daaaeaad3795504a7e02a"></fiddle-embed></div> |
| 1691 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1692 | <a name='SkPaint_isFakeBoldText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1693 | |
| 1694 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1695 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1696 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1697 | bool <a href='#SkPaint_isFakeBoldText'>isFakeBoldText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1698 | </pre> |
| 1699 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1700 | 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] | 1701 | from outlines. |
| 1702 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1703 | 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] | 1704 | |
| 1705 | ### Return Value |
| 1706 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1707 | <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText Flag</a> state |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1708 | |
| 1709 | ### Example |
| 1710 | |
| 1711 | <div><fiddle-embed name="f54d1f85b16073b80b9eef2e1a1d151d"> |
| 1712 | |
| 1713 | #### Example Output |
| 1714 | |
| 1715 | ~~~~ |
| 1716 | paint.isFakeBoldText() == !!(paint.getFlags() & SkPaint::kFakeBoldText_Flag) |
| 1717 | paint.isFakeBoldText() == !!(paint.getFlags() & SkPaint::kFakeBoldText_Flag) |
| 1718 | ~~~~ |
| 1719 | |
| 1720 | </fiddle-embed></div> |
| 1721 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1722 | <a name='SkPaint_setFakeBoldText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1723 | |
| 1724 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1725 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1726 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1727 | void <a href='#SkPaint_setFakeBoldText'>setFakeBoldText</a>(bool fakeBoldText) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1728 | </pre> |
| 1729 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 1730 | Increases stroke width when creating glyph bitmaps to approximate a bold typeface. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1731 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1732 | Sets <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText Flag</a> if <a href='#SkPaint_setFakeBoldText_fakeBoldText'>fakeBoldText</a> is true. |
| 1733 | 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] | 1734 | |
| 1735 | ### Parameters |
| 1736 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1737 | <table> <tr> <td><a name='SkPaint_setFakeBoldText_fakeBoldText'><code><strong>fakeBoldText</strong></code></a></td> |
| 1738 | <td>setting for <a href='#SkPaint_kFakeBoldText_Flag'>kFakeBoldText Flag</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1739 | </tr> |
| 1740 | </table> |
| 1741 | |
| 1742 | ### Example |
| 1743 | |
| 1744 | <div><fiddle-embed name="594d47858eb11028cb626515a520910a"> |
| 1745 | |
| 1746 | #### Example Output |
| 1747 | |
| 1748 | ~~~~ |
| 1749 | paint1 == paint2 |
| 1750 | ~~~~ |
| 1751 | |
| 1752 | </fiddle-embed></div> |
| 1753 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1754 | <a name='Full_Hinting_Spacing'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1755 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1756 | 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] | 1757 | 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] | 1758 | <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 |
| 1759 | FreeType as their <a href='undocumented#Engine'>Font Engine</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1760 | |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 1761 | <a href='#Full_Hinting_Spacing'>Full Hinting Spacing</a> is not related to text <a href='undocumented#Kerning'>Kerning</a>, where the space between |
| 1762 | 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] | 1763 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1764 | <a name='SkPaint_isDevKernText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1765 | |
| 1766 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1767 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1768 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1769 | bool <a href='#SkPaint_isDevKernText'>isDevKernText</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1770 | </pre> |
| 1771 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1772 | Deprecated. |
| 1773 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1774 | <a name='SkPaint_setDevKernText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1775 | |
| 1776 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1777 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1778 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1779 | void <a href='#SkPaint_setDevKernText'>setDevKernText</a>(bool) |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1780 | </pre> |
| 1781 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1782 | Deprecated. |
| 1783 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1784 | <a name='Filter_Quality_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1785 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1786 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1787 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1788 | <a href='undocumented#Filter_Quality'>Filter Quality</a> trades speed for image filtering when the image is scaled. |
| 1789 | A lower <a href='undocumented#Filter_Quality'>Filter Quality</a> draws faster, but has less fidelity. |
| 1790 | A higher <a href='undocumented#Filter_Quality'>Filter Quality</a> draws slower, but looks better. |
| 1791 | 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] | 1792 | in a noticeable difference. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1793 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1794 | <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] | 1795 | |
| 1796 | <table> <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1797 | <td><a href='SkCanvas_Reference#SkCanvas_drawBitmap'>SkCanvas::drawBitmap</a></td> |
| 1798 | </tr> <tr> |
| 1799 | <td><a href='SkCanvas_Reference#SkCanvas_drawBitmapRect'>SkCanvas::drawBitmapRect</a></td> |
| 1800 | </tr> <tr> |
| 1801 | <td><a href='SkCanvas_Reference#SkCanvas_drawImage'>SkCanvas::drawImage</a></td> |
| 1802 | </tr> <tr> |
| 1803 | <td><a href='SkCanvas_Reference#SkCanvas_drawImageRect'>SkCanvas::drawImageRect</a></td> |
| 1804 | </tr> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1805 | </table> |
| 1806 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1807 | 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] | 1808 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1809 | <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] | 1810 | |
| 1811 | ### Example |
| 1812 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 1813 | <div><fiddle-embed name="69369cff2f5b145a6f616092513266a0"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1814 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1815 | <a name='SkPaint_getFilterQuality'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1816 | |
| 1817 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1818 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1819 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1820 | <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] | 1821 | </pre> |
| 1822 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1823 | 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] | 1824 | draws faster; a higher setting looks better when the image is scaled. |
| 1825 | |
| 1826 | ### Return Value |
| 1827 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1828 | one of: <a href='undocumented#kNone_SkFilterQuality'>kNone_SkFilterQuality</a>, <a href='undocumented#kLow_SkFilterQuality'>kLow_SkFilterQuality</a>, |
| 1829 | <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] | 1830 | |
| 1831 | ### Example |
| 1832 | |
| 1833 | <div><fiddle-embed name="d4ca1f23809b6835c4ba46ea98a86900"> |
| 1834 | |
| 1835 | #### Example Output |
| 1836 | |
| 1837 | ~~~~ |
| 1838 | kNone_SkFilterQuality == paint.getFilterQuality() |
| 1839 | ~~~~ |
| 1840 | |
| 1841 | </fiddle-embed></div> |
| 1842 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1843 | <a name='SkPaint_setFilterQuality'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1844 | |
| 1845 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1846 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1847 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1848 | 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] | 1849 | </pre> |
| 1850 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1851 | 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] | 1852 | draws faster; a higher setting looks better when the image is scaled. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1853 | 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] | 1854 | |
| 1855 | ### Parameters |
| 1856 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1857 | <table> <tr> <td><a name='SkPaint_setFilterQuality_quality'><code><strong>quality</strong></code></a></td> |
| 1858 | <td>one of: <a href='undocumented#kNone_SkFilterQuality'>kNone_SkFilterQuality</a>, <a href='undocumented#kLow_SkFilterQuality'>kLow_SkFilterQuality</a>, |
| 1859 | <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] | 1860 | </tr> |
| 1861 | </table> |
| 1862 | |
| 1863 | ### Example |
| 1864 | |
| 1865 | <div><fiddle-embed name="e4288fabf24ee60b645e8bb6ea0afadf"> |
| 1866 | |
| 1867 | #### Example Output |
| 1868 | |
| 1869 | ~~~~ |
| 1870 | kHigh_SkFilterQuality == paint.getFilterQuality() |
| 1871 | ~~~~ |
| 1872 | |
| 1873 | </fiddle-embed></div> |
| 1874 | |
| 1875 | ### See Also |
| 1876 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1877 | <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] | 1878 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1879 | <a name='Color_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1880 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1881 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1882 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1883 | | name | description | |
| 1884 | | --- | --- | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1885 | | <a href='#SkPaint_getColor'>getColor</a> | returns <a href='SkColor_Reference#Alpha'>Color Alpha</a> and RGB, one drawing color | |
| 1886 | | <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] | 1887 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1888 | <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] | 1889 | values used to draw a filled or stroked shape in a 32-bit value. Each component |
| 1890 | occupies 8-bits, ranging from zero: no contribution; to 255: full intensity. |
| 1891 | All values in any combination are valid. |
| 1892 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1893 | <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] | 1894 | RGB: red, blue, and green. |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1895 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1896 | 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] | 1897 | positions on the output device, which may have more or fewer bits, and may have |
| 1898 | a different arrangement. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1899 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1900 | | 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] | 1901 | | --- | --- | --- | --- | --- | |
| 1902 | | | 31 - 24 | 23 - 16 | 15 - 8 | 7 - 0 | |
| 1903 | |
| 1904 | ### Example |
| 1905 | |
Ravi Mistry | 874e22b | 2018-07-19 03:49:13 +0000 | [diff] [blame] | 1906 | <div><fiddle-embed name="214b559d75c65a7bef6ef4be1f860053"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1907 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1908 | <a name='SkPaint_getColor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1909 | |
| 1910 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1911 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1912 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1913 | <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] | 1914 | </pre> |
| 1915 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1916 | 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] | 1917 | 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] | 1918 | a color component. |
| 1919 | |
| 1920 | ### Return Value |
| 1921 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1922 | <a href='undocumented#Unpremultiply'>Unpremultiplied</a> ARGB |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1923 | |
| 1924 | ### Example |
| 1925 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 1926 | <div><fiddle-embed name="72d41f890203109a41f589a7403acae9"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1927 | |
| 1928 | #### Example Output |
| 1929 | |
| 1930 | ~~~~ |
| 1931 | Yellow is 100% red, 100% green, and 0% blue. |
| 1932 | ~~~~ |
| 1933 | |
| 1934 | </fiddle-embed></div> |
| 1935 | |
| 1936 | ### See Also |
| 1937 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1938 | <a href='#SkPaint_getColor4f'>getColor4f</a> <a href='SkColor_Reference#SkColor'>SkColor</a> |
| 1939 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1940 | <a name='SkPaint_getColor4f'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1941 | |
| 1942 | --- |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 1943 | |
| 1944 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1945 | <a href='SkColor4f_Reference#SkColor4f'>SkColor4f</a> <a href='#SkPaint_getColor4f'>getColor4f</a>() const |
| 1946 | </pre> |
| 1947 | |
| 1948 | Retrieves alpha and RGB, unpmreultiplied, as four floating point values. RGB are |
| 1949 | are extended sRGB values (sRGB gamut, and encoded with the sRGB transfer function). |
| 1950 | |
| 1951 | ### Return Value |
| 1952 | |
| 1953 | <a href='undocumented#Unpremultiply'>Unpremultiplied</a> RGBA |
| 1954 | |
| 1955 | ### Example |
| 1956 | |
| 1957 | <div><fiddle-embed name="8512ea2176f36e8f1aeef311ff228790"> |
| 1958 | |
| 1959 | #### Example Output |
| 1960 | |
| 1961 | ~~~~ |
| 1962 | Yellow is 100% red, 100% green, and 0% blue. |
| 1963 | ~~~~ |
| 1964 | |
| 1965 | </fiddle-embed></div> |
| 1966 | |
| 1967 | ### See Also |
| 1968 | |
| 1969 | <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] | 1970 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1971 | <a name='SkPaint_setColor'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 1972 | |
| 1973 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1974 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1975 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 1976 | 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] | 1977 | </pre> |
| 1978 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1979 | 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, |
| 1980 | <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] | 1981 | |
| 1982 | ### Parameters |
| 1983 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1984 | <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] | 1985 | <td><a href='undocumented#Unpremultiply'>Unpremultiplied</a> ARGB</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1986 | </tr> |
| 1987 | </table> |
| 1988 | |
| 1989 | ### Example |
| 1990 | |
skia-bookmaker | 233c652 | 2018-07-04 05:33:26 +0000 | [diff] [blame] | 1991 | <div><fiddle-embed name="6e70f18300bd676a3c056ceb6b62f8df"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 1992 | |
| 1993 | #### Example Output |
| 1994 | |
| 1995 | ~~~~ |
| 1996 | green1 == green2 |
| 1997 | ~~~~ |
| 1998 | |
| 1999 | </fiddle-embed></div> |
| 2000 | |
| 2001 | ### See Also |
| 2002 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 2003 | <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> |
| 2004 | |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 2005 | <a name='SkPaint_setColor4f'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2006 | |
| 2007 | --- |
Cary Clark | bbe8ff9 | 2018-09-05 11:39:01 -0400 | [diff] [blame] | 2008 | |
| 2009 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2010 | void <a href='#SkPaint_setColor4f'>setColor4f</a>(const <a href='SkColor4f_Reference#SkColor4f'>SkColor4f</a>& color, <a href='undocumented#SkColorSpace'>SkColorSpace</a>* colorSpace) |
| 2011 | </pre> |
| 2012 | |
| 2013 | Sets alpha and RGB used when stroking and filling. The <a href='#SkPaint_setColor4f_color'>color</a> is four floating |
| 2014 | point values, unpremultiplied. The <a href='#SkPaint_setColor4f_color'>color</a> values are interpreted as being in |
| 2015 | 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 |
| 2016 | sRGB <a href='#SkPaint_setColor4f_color'>color</a> space. |
| 2017 | |
| 2018 | ### Parameters |
| 2019 | |
| 2020 | <table> <tr> <td><a name='SkPaint_setColor4f_color'><code><strong>color</strong></code></a></td> |
| 2021 | <td><a href='undocumented#Unpremultiply'>Unpremultiplied</a> RGBA</td> |
| 2022 | </tr> |
| 2023 | <tr> <td><a name='SkPaint_setColor4f_colorSpace'><code><strong>colorSpace</strong></code></a></td> |
| 2024 | <td><a href='undocumented#Color_Space'>Color Space</a> describing the encoding of <a href='#SkPaint_setColor4f_color'>color</a></td> |
| 2025 | </tr> |
| 2026 | </table> |
| 2027 | |
| 2028 | ### Example |
| 2029 | |
| 2030 | <div><fiddle-embed name="fa60859e3d03bdc117a05b32e093a8f1"> |
| 2031 | |
| 2032 | #### Example Output |
| 2033 | |
| 2034 | ~~~~ |
| 2035 | green1 == green2 |
| 2036 | ~~~~ |
| 2037 | |
| 2038 | </fiddle-embed></div> |
| 2039 | |
| 2040 | ### See Also |
| 2041 | |
| 2042 | <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] | 2043 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2044 | <a name='Alpha_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2045 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 2046 | <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] | 2047 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2048 | <a name='SkPaint_getAlpha'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2049 | |
| 2050 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2051 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2052 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2053 | uint8_t <a href='#SkPaint_getAlpha'>getAlpha</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2054 | </pre> |
| 2055 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2056 | 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] | 2057 | |
| 2058 | ### Return Value |
| 2059 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2060 | <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] | 2061 | |
| 2062 | ### Example |
| 2063 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 2064 | <div><fiddle-embed name="9a85bb62fe3d877b18fb7f952c4fa7f7"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2065 | |
| 2066 | #### Example Output |
| 2067 | |
| 2068 | ~~~~ |
| 2069 | 255 == paint.getAlpha() |
| 2070 | ~~~~ |
| 2071 | |
| 2072 | </fiddle-embed></div> |
| 2073 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2074 | <a name='SkPaint_setAlpha'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2075 | |
| 2076 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2077 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2078 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2079 | 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] | 2080 | </pre> |
| 2081 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 2082 | Replaces <a href='SkColor_Reference#Alpha'>Alpha</a>, leaving RGB |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2083 | unchanged. An out of range value triggers an assert in the debug |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2084 | build. <a href='#SkPaint_setAlpha_a'>a</a> is <a href='#SkPaint_setAlpha_a'>a</a> value from zero to 255. |
| 2085 | <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] | 2086 | fully opaque. |
| 2087 | |
| 2088 | ### Parameters |
| 2089 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2090 | <table> <tr> <td><a name='SkPaint_setAlpha_a'><code><strong>a</strong></code></a></td> |
| 2091 | <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] | 2092 | </tr> |
| 2093 | </table> |
| 2094 | |
| 2095 | ### Example |
| 2096 | |
Ravi Mistry | 874e22b | 2018-07-19 03:49:13 +0000 | [diff] [blame] | 2097 | <div><fiddle-embed name="6ddc0360512dfb9947e75c17e6a8103d"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2098 | |
| 2099 | #### Example Output |
| 2100 | |
| 2101 | ~~~~ |
| 2102 | 0x44112233 == paint.getColor() |
| 2103 | ~~~~ |
| 2104 | |
| 2105 | </fiddle-embed></div> |
| 2106 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2107 | <a name='SkPaint_setARGB'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2108 | |
| 2109 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2110 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2111 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2112 | 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] | 2113 | </pre> |
| 2114 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2115 | 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] | 2116 | 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] | 2117 | |
| 2118 | ### Parameters |
| 2119 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2120 | <table> <tr> <td><a name='SkPaint_setARGB_a'><code><strong>a</strong></code></a></td> |
| 2121 | <td>amount of <a href='SkColor_Reference#Alpha'>Color Alpha</a>, from fully transparent (0) to fully opaque (255)</td> |
| 2122 | </tr> |
| 2123 | <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] | 2124 | <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] | 2125 | </tr> |
| 2126 | <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] | 2127 | <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] | 2128 | </tr> |
| 2129 | <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] | 2130 | <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] | 2131 | </tr> |
| 2132 | </table> |
| 2133 | |
| 2134 | ### Example |
| 2135 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 2136 | <div><fiddle-embed name="cb62e4755789ed32f7120dc55984959d"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2137 | |
| 2138 | #### Example Output |
| 2139 | |
| 2140 | ~~~~ |
| 2141 | transRed1 == transRed2 |
| 2142 | ~~~~ |
| 2143 | |
| 2144 | </fiddle-embed></div> |
| 2145 | |
| 2146 | ### See Also |
| 2147 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2148 | <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] | 2149 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2150 | <a name='Style'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2151 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2152 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2153 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2154 | <a href='#SkPaint_Style'>Style</a> specifies if the geometry is filled, stroked, or both filled and stroked. |
| 2155 | 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] | 2156 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2157 | <a name='Style_Fill'></a> |
| 2158 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2159 | 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] | 2160 | The fill covers the area inside the geometry for most shapes. |
| 2161 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2162 | <a name='Style_Stroke'></a> |
| 2163 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2164 | 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] | 2165 | |
Cary Clark | bc5697d | 2017-10-04 14:31:33 -0400 | [diff] [blame] | 2166 | 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] | 2167 | <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>. |
| 2168 | 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^] | 2169 | 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] | 2170 | 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] | 2171 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2172 | ### See Also |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2173 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2174 | <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> |
| 2175 | |
| 2176 | <a name='Hairline'></a> |
| 2177 | |
| 2178 | --- |
| 2179 | |
| 2180 | <a href='#Stroke_Width'>Stroke Width</a> of zero has a special meaning and switches drawing to use <a href='#Hairline'>Hairline</a>. |
| 2181 | <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] | 2182 | flow horizontally, vertically,or diagonally. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2183 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2184 | <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] | 2185 | 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] | 2186 | 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] | 2187 | 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] | 2188 | while stroking. |
| 2189 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2190 | ### See Also |
| 2191 | |
| 2192 | <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> |
| 2193 | |
| 2194 | <a name='SkPaint_Style'></a> |
| 2195 | |
| 2196 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2197 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 2198 | <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] | 2199 | enum <a href='#SkPaint_Style'>Style</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2200 | <a href='#SkPaint_kFill_Style'>kFill_Style</a>, |
| 2201 | <a href='#SkPaint_kStroke_Style'>kStroke_Style</a>, |
| 2202 | <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill_Style</a>, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 2203 | }; |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2204 | </pre> |
Cary Clark | d98f78c | 2018-04-26 08:32:37 -0400 | [diff] [blame] | 2205 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2206 | <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] | 2207 | 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] | 2208 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2209 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2210 | 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] | 2211 | The stroke and fill |
| 2212 | share all paint attributes; for instance, they are drawn with the same color. |
| 2213 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2214 | 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] | 2215 | a fill draw. |
| 2216 | |
| 2217 | ### Constants |
| 2218 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2219 | <table style='border-collapse: collapse; width: 62.5em'> |
| 2220 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 2221 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 2222 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 2223 | <tr style='background-color: #f0f0f0; '> |
| 2224 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kFill_Style'><code>SkPaint::kFill_Style</code></a></td> |
| 2225 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2226 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | d2ca79c | 2018-08-10 13:09:13 -0400 | [diff] [blame] | 2227 | 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>. |
| 2228 | <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] | 2229 | <a href='#SkPaint_kFill_Style'>kFill Style</a> is set, and ignore the set <a href='#SkPaint_Style'>Style</a>. |
| 2230 | 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] | 2231 | and to create an unfilled hole inside the shape. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2232 | <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] | 2233 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2234 | </tr> |
| 2235 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2236 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStroke_Style'><code>SkPaint::kStroke_Style</code></a></td> |
| 2237 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2238 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | d2ca79c | 2018-08-10 13:09:13 -0400 | [diff] [blame] | 2239 | 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] | 2240 | <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, |
| 2241 | and ignore the set <a href='#SkPaint_Style'>Style</a>. |
| 2242 | The stroke construction is unaffected by the <a href='SkPath_Reference#Fill_Type'>Path Fill Type</a>. |
| 2243 | </td> |
| 2244 | </tr> |
| 2245 | <tr style='background-color: #f0f0f0; '> |
| 2246 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStrokeAndFill_Style'><code>SkPaint::kStrokeAndFill_Style</code></a></td> |
| 2247 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2248 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | d2ca79c | 2018-08-10 13:09:13 -0400 | [diff] [blame] | 2249 | 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] | 2250 | <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>, |
| 2251 | 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] | 2252 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2253 | </tr> |
| 2254 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2255 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kStyleCount'><code>SkPaint::kStyleCount</code></a></td> |
| 2256 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 2257 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2258 | 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] | 2259 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2260 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2261 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2262 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2263 | <a name='SkPaint_getStyle'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2264 | |
| 2265 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2266 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2267 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2268 | <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] | 2269 | </pre> |
| 2270 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2271 | Returns whether the geometry is filled, stroked, or filled and stroked. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2272 | |
| 2273 | ### Return Value |
| 2274 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2275 | 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] | 2276 | |
| 2277 | ### Example |
| 2278 | |
| 2279 | <div><fiddle-embed name="1c5e18c3c0102d2dac86a78ba8c8ce01"> |
| 2280 | |
| 2281 | #### Example Output |
| 2282 | |
| 2283 | ~~~~ |
| 2284 | SkPaint::kFill_Style == paint.getStyle() |
| 2285 | ~~~~ |
| 2286 | |
| 2287 | </fiddle-embed></div> |
| 2288 | |
| 2289 | ### See Also |
| 2290 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2291 | <a href='#SkPaint_Style'>Style</a> <a href='#SkPaint_setStyle'>setStyle</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2292 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2293 | <a name='SkPaint_setStyle'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2294 | |
| 2295 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2296 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2297 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2298 | 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] | 2299 | </pre> |
| 2300 | |
| 2301 | Sets whether the geometry is filled, stroked, or filled and stroked. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2302 | 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] | 2303 | |
| 2304 | ### Parameters |
| 2305 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2306 | <table> <tr> <td><a name='SkPaint_setStyle_style'><code><strong>style</strong></code></a></td> |
| 2307 | <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] | 2308 | </tr> |
| 2309 | </table> |
| 2310 | |
| 2311 | ### Example |
| 2312 | |
| 2313 | <div><fiddle-embed name="c7bb6248e4735b8d1a32d02fba40d344"></fiddle-embed></div> |
| 2314 | |
| 2315 | ### See Also |
| 2316 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2317 | <a href='#SkPaint_Style'>Style</a> <a href='#SkPaint_getStyle'>getStyle</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2318 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2319 | <a name='Stroke_Width'></a> |
| 2320 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2321 | --- |
| 2322 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2323 | <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] | 2324 | 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] | 2325 | 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] | 2326 | |
| 2327 | When width is greater than zero, the stroke encompasses as many pixels partially |
| 2328 | 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] | 2329 | the stroke is always one pixel wide. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2330 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2331 | 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] | 2332 | remains one pixel wide regardless of scaling. |
| 2333 | |
| 2334 | The default width for the paint is zero. |
| 2335 | |
| 2336 | ### Example |
| 2337 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 2338 | <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] | 2339 | line and the platform implementation. |
| 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_getStrokeWidth'></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_getStrokeWidth'>getStrokeWidth</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2348 | </pre> |
| 2349 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2350 | 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] | 2351 | outline the shape. |
| 2352 | |
| 2353 | ### Return Value |
| 2354 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2355 | 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] | 2356 | |
| 2357 | ### Example |
| 2358 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 2359 | <div><fiddle-embed name="99aa73f64df8bbf06e656cd891a81b9e"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2360 | |
| 2361 | #### Example Output |
| 2362 | |
| 2363 | ~~~~ |
| 2364 | 0 == paint.getStrokeWidth() |
| 2365 | ~~~~ |
| 2366 | |
| 2367 | </fiddle-embed></div> |
| 2368 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2369 | <a name='SkPaint_setStrokeWidth'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2370 | |
| 2371 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2372 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2373 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2374 | 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] | 2375 | </pre> |
| 2376 | |
| 2377 | Sets the thickness of the pen used by the paint to |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 2378 | outline the shape. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2379 | 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] | 2380 | |
| 2381 | ### Parameters |
| 2382 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2383 | <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^] | 2384 | <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] | 2385 | </tr> |
| 2386 | </table> |
| 2387 | |
| 2388 | ### Example |
| 2389 | |
| 2390 | <div><fiddle-embed name="0c4446c0870b5c7b5a2efe77ff92afb8"> |
| 2391 | |
| 2392 | #### Example Output |
| 2393 | |
| 2394 | ~~~~ |
| 2395 | 5 == paint.getStrokeWidth() |
| 2396 | ~~~~ |
| 2397 | |
| 2398 | </fiddle-embed></div> |
| 2399 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2400 | <a name='Miter_Limit'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2401 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2402 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2403 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2404 | <a href='#Miter_Limit'>Miter Limit</a> specifies the maximum miter length, |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2405 | relative to the stroke width. |
| 2406 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2407 | <a href='#Miter_Limit'>Miter Limit</a> is used when the <a href='#Stroke_Join'>Stroke Join</a> |
| 2408 | 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> |
| 2409 | or <a href='#SkPaint_kStrokeAndFill_Style'>kStrokeAndFill Style</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2410 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2411 | If the miter at a corner exceeds this limit, <a href='#SkPaint_kMiter_Join'>kMiter Join</a> |
| 2412 | is replaced with <a href='#SkPaint_kBevel_Join'>kBevel Join</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2413 | |
Cary Clark | 2be81cf | 2018-09-13 12:04:30 -0400 | [diff] [blame] | 2414 | <a href='#Miter_Limit'>Miter Limit</a> can be computed from the corner angle using: |
| 2415 | <code>miter limit = 1 / sin \( angle / 2 \)</code>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2416 | |
Cary Clark | 2be81cf | 2018-09-13 12:04:30 -0400 | [diff] [blame] | 2417 | <a href='#Miter_Limit'>Miter Limit</a> default value is 4. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2418 | 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] | 2419 | in "SkUserConfig.h" or as a define supplied by the build environment. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2420 | |
| 2421 | Here are some miter limits and the angles that triggers them. |
| 2422 | |
| 2423 | | miter limit | angle in degrees | |
| 2424 | | --- | --- | |
| 2425 | | 10 | 11.48 | |
| 2426 | | 9 | 12.76 | |
| 2427 | | 8 | 14.36 | |
| 2428 | | 7 | 16.43 | |
| 2429 | | 6 | 19.19 | |
| 2430 | | 5 | 23.07 | |
| 2431 | | 4 | 28.96 | |
| 2432 | | 3 | 38.94 | |
| 2433 | | 2 | 60 | |
| 2434 | | 1 | 180 | |
| 2435 | |
| 2436 | ### Example |
| 2437 | |
Cary Clark | a619d45 | 2018-07-16 08:12:01 -0400 | [diff] [blame] | 2438 | <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] | 2439 | When the miter limit is decreased slightly, the miter join is replaced |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2440 | by a bevel join. |
| 2441 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2442 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2443 | <a name='SkPaint_getStrokeMiter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2444 | |
| 2445 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2446 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2447 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2448 | <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] | 2449 | </pre> |
| 2450 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2451 | Returns the limit at which a sharp corner is drawn beveled. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2452 | |
| 2453 | ### Return Value |
| 2454 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2455 | zero and greater <a href='#Miter_Limit'>Miter Limit</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2456 | |
| 2457 | ### Example |
| 2458 | |
| 2459 | <div><fiddle-embed name="50da74a43b725f07a914df588c867d36"> |
| 2460 | |
| 2461 | #### Example Output |
| 2462 | |
| 2463 | ~~~~ |
| 2464 | default miter limit == 4 |
| 2465 | ~~~~ |
| 2466 | |
| 2467 | </fiddle-embed></div> |
| 2468 | |
| 2469 | ### See Also |
| 2470 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2471 | <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] | 2472 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2473 | <a name='SkPaint_setStrokeMiter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2474 | |
| 2475 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2476 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2477 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2478 | 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] | 2479 | </pre> |
| 2480 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2481 | Sets the limit at which a sharp corner is drawn beveled. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2482 | Valid values are zero and greater. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2483 | 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] | 2484 | |
| 2485 | ### Parameters |
| 2486 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2487 | <table> <tr> <td><a name='SkPaint_setStrokeMiter_miter'><code><strong>miter</strong></code></a></td> |
| 2488 | <td>zero and greater <a href='#Miter_Limit'>Miter Limit</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2489 | </tr> |
| 2490 | </table> |
| 2491 | |
| 2492 | ### Example |
| 2493 | |
skia-bookmaker | a717ca9 | 2018-07-08 05:32:09 +0000 | [diff] [blame] | 2494 | <div><fiddle-embed name="700b284dbc97785c6a9c9636088713ad"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2495 | |
| 2496 | #### Example Output |
| 2497 | |
| 2498 | ~~~~ |
| 2499 | default miter limit == 8 |
| 2500 | ~~~~ |
| 2501 | |
| 2502 | </fiddle-embed></div> |
| 2503 | |
| 2504 | ### See Also |
| 2505 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2506 | <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] | 2507 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2508 | <a name='Stroke_Cap'></a> |
| 2509 | |
| 2510 | <a name='SkPaint_Cap'></a> |
| 2511 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2512 | --- |
| 2513 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 2514 | <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] | 2515 | enum <a href='#SkPaint_Cap'>Cap</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2516 | <a href='#SkPaint_kButt_Cap'>kButt_Cap</a>, |
| 2517 | <a href='#SkPaint_kRound_Cap'>kRound_Cap</a>, |
| 2518 | <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a>, |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2519 | <a href='#SkPaint_kLast_Cap'>kLast_Cap</a> = <a href='#SkPaint_kSquare_Cap'>kSquare_Cap</a>, |
| 2520 | <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] | 2521 | }; |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2522 | </pre> |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 2523 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2524 | <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] | 2525 | 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] | 2526 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2527 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2528 | <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] | 2529 | |
| 2530 | ### Constants |
| 2531 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2532 | <table style='border-collapse: collapse; width: 62.5em'> |
| 2533 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 2534 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 2535 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 2536 | <tr style='background-color: #f0f0f0; '> |
| 2537 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kButt_Cap'><code>SkPaint::kButt_Cap</code></a></td> |
| 2538 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2539 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2540 | Does not extend the stroke past the beginning or the end. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2541 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2542 | </tr> |
| 2543 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2544 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kRound_Cap'><code>SkPaint::kRound_Cap</code></a></td> |
| 2545 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2546 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2547 | 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] | 2548 | and end. |
| 2549 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2550 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2551 | <tr style='background-color: #f0f0f0; '> |
| 2552 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kSquare_Cap'><code>SkPaint::kSquare_Cap</code></a></td> |
| 2553 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2554 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2555 | 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] | 2556 | 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] | 2557 | of the stroke. |
| 2558 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2559 | </tr> |
| 2560 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2561 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLast_Cap'><code>SkPaint::kLast_Cap</code></a></td> |
| 2562 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2563 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2564 | Equivalent to the largest value for <a href='#Stroke_Cap'>Stroke Cap</a>. |
| 2565 | </td> |
| 2566 | </tr> |
| 2567 | <tr style='background-color: #f0f0f0; '> |
| 2568 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kDefault_Cap'><code>SkPaint::kDefault_Cap</code></a></td> |
| 2569 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2570 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2571 | <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] | 2572 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2573 | </tr> |
| 2574 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2575 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kCapCount'><code>SkPaint::kCapCount</code></a></td> |
| 2576 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 2577 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2578 | 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] | 2579 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2580 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2581 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2582 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2583 | 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] | 2584 | 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] | 2585 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2586 | 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] | 2587 | visible beginning and end. |
| 2588 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2589 | <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] | 2590 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2591 | <a href='#SkPaint_kButt_Cap'>kButt Cap</a> and <a href='SkPath_Overview#Contour_Zero_Length'>Zero Length Contour</a> is not drawn. |
| 2592 | <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] | 2593 | at the contour point. |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2594 | <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] | 2595 | <a href='#Stroke_Width'>Stroke Width</a> at the contour point. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2596 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2597 | <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] | 2598 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2599 | ### Example |
| 2600 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2601 | <div><fiddle-embed name="2bffb6384cc20077e632e7d01da045ca"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2602 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2603 | <a name='SkPaint_getStrokeCap'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2604 | |
| 2605 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2606 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2607 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2608 | <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] | 2609 | </pre> |
| 2610 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2611 | Returns the geometry drawn at the beginning and end of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2612 | |
| 2613 | ### Return Value |
| 2614 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2615 | 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] | 2616 | |
| 2617 | ### Example |
| 2618 | |
| 2619 | <div><fiddle-embed name="aabf9baee8e026fae36fca30e955512b"> |
| 2620 | |
| 2621 | #### Example Output |
| 2622 | |
| 2623 | ~~~~ |
| 2624 | kButt_Cap == default stroke cap |
| 2625 | ~~~~ |
| 2626 | |
| 2627 | </fiddle-embed></div> |
| 2628 | |
| 2629 | ### See Also |
| 2630 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2631 | <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] | 2632 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2633 | <a name='SkPaint_setStrokeCap'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2634 | |
| 2635 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2636 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2637 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2638 | 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] | 2639 | </pre> |
| 2640 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2641 | Sets the geometry drawn at the beginning and end of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2642 | |
| 2643 | ### Parameters |
| 2644 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2645 | <table> <tr> <td><a name='SkPaint_setStrokeCap_cap'><code><strong>cap</strong></code></a></td> |
| 2646 | <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>; |
| 2647 | 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] | 2648 | </tr> |
| 2649 | </table> |
| 2650 | |
| 2651 | ### Example |
| 2652 | |
| 2653 | <div><fiddle-embed name="de83fbd848a4625345b4b87a6e55d98a"> |
| 2654 | |
| 2655 | #### Example Output |
| 2656 | |
| 2657 | ~~~~ |
| 2658 | kRound_Cap == paint.getStrokeCap() |
| 2659 | ~~~~ |
| 2660 | |
| 2661 | </fiddle-embed></div> |
| 2662 | |
| 2663 | ### See Also |
| 2664 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2665 | <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] | 2666 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2667 | <a name='Stroke_Join'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2668 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2669 | <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] | 2670 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2671 | 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] | 2672 | 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] | 2673 | |
| 2674 | If the contour direction changes abruptly, because the tangent direction leading |
| 2675 | 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] | 2676 | 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] | 2677 | |
| 2678 | ### Example |
| 2679 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2680 | <div><fiddle-embed name="917c44b504d3f9308571fd3835d90a0d"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2681 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2682 | <a name='SkPaint_Join'></a> |
| 2683 | |
| 2684 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2685 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 2686 | <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] | 2687 | enum <a href='#SkPaint_Join'>Join</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2688 | <a href='#SkPaint_kMiter_Join'>kMiter_Join</a>, |
| 2689 | <a href='#SkPaint_kRound_Join'>kRound_Join</a>, |
| 2690 | <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>, |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2691 | <a href='#SkPaint_kLast_Join'>kLast_Join</a> = <a href='#SkPaint_kBevel_Join'>kBevel_Join</a>, |
| 2692 | <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] | 2693 | }; |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2694 | </pre> |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 2695 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2696 | <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] | 2697 | 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] | 2698 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2699 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2700 | <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] | 2701 | affects the four corners of a stroked rectangle, and the connected segments in a |
| 2702 | stroked path. |
| 2703 | |
| 2704 | Choose miter join to draw sharp corners. Choose round join to draw a circle with a |
| 2705 | radius equal to the stroke width on top of the corner. Choose bevel join to minimally |
| 2706 | connect the thick strokes. |
| 2707 | |
Cary Clark | 7cfcbca | 2018-01-04 16:11:51 -0500 | [diff] [blame] | 2708 | 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] | 2709 | not contain the actual join. For instance, a fill path constructed with round joins does |
| 2710 | not necessarily include circles at each connected segment. |
| 2711 | |
| 2712 | ### Constants |
| 2713 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2714 | <table style='border-collapse: collapse; width: 62.5em'> |
| 2715 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 2716 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 2717 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 2718 | <tr style='background-color: #f0f0f0; '> |
| 2719 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kMiter_Join'><code>SkPaint::kMiter_Join</code></a></td> |
| 2720 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 2721 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2722 | Extends the outside corner to the extent allowed by <a href='#Miter_Limit'>Miter Limit</a>. |
| 2723 | 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] | 2724 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2725 | </tr> |
| 2726 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2727 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kRound_Join'><code>SkPaint::kRound_Join</code></a></td> |
| 2728 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2729 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2730 | Adds a circle with a diameter of <a href='#Stroke_Width'>Stroke Width</a> at the sharp corner. |
| 2731 | </td> |
| 2732 | </tr> |
| 2733 | <tr style='background-color: #f0f0f0; '> |
| 2734 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kBevel_Join'><code>SkPaint::kBevel_Join</code></a></td> |
| 2735 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2736 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2737 | Connects the outside edges of the sharp corner. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 2738 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2739 | </tr> |
| 2740 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2741 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLast_Join'><code>SkPaint::kLast_Join</code></a></td> |
| 2742 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 2743 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2744 | equivalent to the largest value for Stroke_Join</td> |
| 2745 | </tr> |
| 2746 | <tr style='background-color: #f0f0f0; '> |
| 2747 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kDefault_Join'><code>SkPaint::kDefault_Join</code></a></td> |
| 2748 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 2749 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2750 | <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] | 2751 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2752 | </tr> |
| 2753 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2754 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kJoinCount'><code>SkPaint::kJoinCount</code></a></td> |
| 2755 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 2756 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 2757 | 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] | 2758 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2759 | </tr> |
| 2760 | </table> |
| 2761 | |
| 2762 | ### Example |
| 2763 | |
| 2764 | <div><fiddle-embed name="3b1aebacc21c1836a52876b9b0b3905e"></fiddle-embed></div> |
| 2765 | |
| 2766 | ### See Also |
| 2767 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2768 | <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] | 2769 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2770 | <a name='SkPaint_getStrokeJoin'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2771 | |
| 2772 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2773 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2774 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2775 | <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] | 2776 | </pre> |
| 2777 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2778 | Returns the geometry drawn at the corners of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2779 | |
| 2780 | ### Return Value |
| 2781 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2782 | 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] | 2783 | |
| 2784 | ### Example |
| 2785 | |
Cary Clark | 7f644ec | 2018-07-19 10:50:44 -0400 | [diff] [blame] | 2786 | <div><fiddle-embed name="31bf751d0a8ddf176b871810820d8199"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2787 | |
| 2788 | #### Example Output |
| 2789 | |
| 2790 | ~~~~ |
| 2791 | kMiter_Join == default stroke join |
| 2792 | ~~~~ |
| 2793 | |
| 2794 | </fiddle-embed></div> |
| 2795 | |
| 2796 | ### See Also |
| 2797 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2798 | <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] | 2799 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2800 | <a name='SkPaint_setStrokeJoin'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2801 | |
| 2802 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2803 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2804 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2805 | 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] | 2806 | </pre> |
| 2807 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2808 | Sets the geometry drawn at the corners of strokes. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2809 | |
| 2810 | ### Parameters |
| 2811 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2812 | <table> <tr> <td><a name='SkPaint_setStrokeJoin_join'><code><strong>join</strong></code></a></td> |
| 2813 | <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] | 2814 | otherwise, has no effect</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2815 | </tr> |
| 2816 | </table> |
| 2817 | |
| 2818 | ### Example |
| 2819 | |
| 2820 | <div><fiddle-embed name="48d963ad4286eddf680f9c511eb6da91"> |
| 2821 | |
| 2822 | #### Example Output |
| 2823 | |
| 2824 | ~~~~ |
| 2825 | kMiter_Join == paint.getStrokeJoin() |
| 2826 | ~~~~ |
| 2827 | |
| 2828 | </fiddle-embed></div> |
| 2829 | |
| 2830 | ### See Also |
| 2831 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2832 | <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] | 2833 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2834 | ### See Also |
| 2835 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2836 | <a href='#Miter_Limit'>Miter Limit</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2837 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2838 | <a name='Fill_Path'></a> |
| 2839 | |
| 2840 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2841 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2842 | <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] | 2843 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2844 | 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 |
| 2845 | replaces the destination <a href='SkPath_Reference#Path'>Path</a>. Otherwise, the source <a href='SkPath_Reference#Path'>Path</a> is replaces the |
| 2846 | destination <a href='SkPath_Reference#Path'>Path</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2847 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2848 | 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 |
| 2849 | 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] | 2850 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2851 | 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>, |
| 2852 | 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>, |
| 2853 | 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] | 2854 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2855 | 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] | 2856 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2857 | 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^] | 2858 | returns false since <a href='#Hairline'>Hairline</a> has no filled equivalent. |
| 2859 | |
| 2860 | ### See Also |
| 2861 | |
| 2862 | <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] | 2863 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2864 | <a name='SkPaint_getFillPath'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2865 | |
| 2866 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2867 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2868 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2869 | 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] | 2870 | </pre> |
| 2871 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2872 | Returns the filled equivalent of the stroked path. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2873 | |
| 2874 | ### Parameters |
| 2875 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2876 | <table> <tr> <td><a name='SkPaint_getFillPath_src'><code><strong>src</strong></code></a></td> |
| 2877 | <td><a href='SkPath_Reference#Path'>Path</a> read to create a filled version</td> |
| 2878 | </tr> |
| 2879 | <tr> <td><a name='SkPaint_getFillPath_dst'><code><strong>dst</strong></code></a></td> |
| 2880 | <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> |
| 2881 | </tr> |
| 2882 | <tr> <td><a name='SkPaint_getFillPath_cullRect'><code><strong>cullRect</strong></code></a></td> |
| 2883 | <td>optional limit passed to <a href='undocumented#Path_Effect'>Path Effect</a></td> |
| 2884 | </tr> |
| 2885 | <tr> <td><a name='SkPaint_getFillPath_resScale'><code><strong>resScale</strong></code></a></td> |
| 2886 | <td>if > 1, increase precision, else if (0 < res < 1) reduce precision |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2887 | to favor speed and size</td> |
| 2888 | </tr> |
| 2889 | </table> |
| 2890 | |
| 2891 | ### Return Value |
| 2892 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2893 | 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] | 2894 | |
| 2895 | ### Example |
| 2896 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2897 | <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. |
| 2898 | 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] | 2899 | At the highest precision, the filled path has high fidelity compared to the original stroke. |
| 2900 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2901 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2902 | <a name='SkPaint_getFillPath_2'></a> |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 2903 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2904 | --- |
| 2905 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2906 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2907 | 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] | 2908 | </pre> |
| 2909 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2910 | Returns the filled equivalent of the stroked path. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2911 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2912 | 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>. |
| 2913 | <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] | 2914 | |
| 2915 | ### Parameters |
| 2916 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2917 | <table> <tr> <td><a name='SkPaint_getFillPath_2_src'><code><strong>src</strong></code></a></td> |
| 2918 | <td><a href='SkPath_Reference#Path'>Path</a> read to create a filled version</td> |
| 2919 | </tr> |
| 2920 | <tr> <td><a name='SkPaint_getFillPath_2_dst'><code><strong>dst</strong></code></a></td> |
| 2921 | <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] | 2922 | </tr> |
| 2923 | </table> |
| 2924 | |
| 2925 | ### Return Value |
| 2926 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2927 | 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] | 2928 | |
| 2929 | ### Example |
| 2930 | |
| 2931 | <div><fiddle-embed name="e6d8ca0cc17e0b475bd54dd995825468"></fiddle-embed></div> |
| 2932 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2933 | <a name='Shader_Methods'></a> |
| 2934 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2935 | --- |
| 2936 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2937 | <a href='undocumented#Shader'>Shader</a> defines the colors used when drawing a shape. |
| 2938 | <a href='undocumented#Shader'>Shader</a> may be an image, a gradient, or a computed fill. |
| 2939 | 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] | 2940 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2941 | <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>. |
| 2942 | 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] | 2943 | the fill. |
| 2944 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2945 | 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] | 2946 | |
| 2947 | ### Example |
| 2948 | |
| 2949 | <div><fiddle-embed name="c015dc2010c15e1c00b4f7330232b0f7"></fiddle-embed></div> |
| 2950 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2951 | 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] | 2952 | |
| 2953 | ### Example |
| 2954 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 2955 | <div><fiddle-embed name="fe80fd80b98a20823db7fb9a077243c7"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2956 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2957 | <a name='SkPaint_getShader'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2958 | |
| 2959 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2960 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2961 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2962 | <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] | 2963 | </pre> |
| 2964 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2965 | Returns optional colors used when filling a path, such as a gradient. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2966 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2967 | 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] | 2968 | |
| 2969 | ### Return Value |
| 2970 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2971 | <a href='undocumented#Shader'>Shader</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2972 | |
| 2973 | ### Example |
| 2974 | |
| 2975 | <div><fiddle-embed name="09f15b9fd88882850da2d235eb86292f"> |
| 2976 | |
| 2977 | #### Example Output |
| 2978 | |
| 2979 | ~~~~ |
| 2980 | nullptr == shader |
| 2981 | nullptr != shader |
| 2982 | ~~~~ |
| 2983 | |
| 2984 | </fiddle-embed></div> |
| 2985 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2986 | <a name='SkPaint_refShader'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 2987 | |
| 2988 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2989 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2990 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 2991 | <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] | 2992 | </pre> |
| 2993 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 2994 | Returns optional colors used when filling a path, such as a gradient. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 2995 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2996 | 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] | 2997 | |
| 2998 | ### Return Value |
| 2999 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3000 | <a href='undocumented#Shader'>Shader</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3001 | |
| 3002 | ### Example |
| 3003 | |
| 3004 | <div><fiddle-embed name="53da0295972a418cbc9607bbb17feaa8"> |
| 3005 | |
| 3006 | #### Example Output |
| 3007 | |
| 3008 | ~~~~ |
| 3009 | shader unique: true |
| 3010 | shader unique: false |
| 3011 | ~~~~ |
| 3012 | |
| 3013 | </fiddle-embed></div> |
| 3014 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3015 | <a name='SkPaint_setShader'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3016 | |
| 3017 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3018 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3019 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3020 | 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] | 3021 | </pre> |
| 3022 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 3023 | Sets optional colors used when filling a path, such as a gradient. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3024 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3025 | 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>. |
| 3026 | 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] | 3027 | |
| 3028 | ### Parameters |
| 3029 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3030 | <table> <tr> <td><a name='SkPaint_setShader_shader'><code><strong>shader</strong></code></a></td> |
| 3031 | <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] | 3032 | </tr> |
| 3033 | </table> |
| 3034 | |
| 3035 | ### Example |
| 3036 | |
skia-bookmaker | e0a458f | 2018-07-16 05:29:00 +0000 | [diff] [blame] | 3037 | <div><fiddle-embed name="77e64d5bae9b1ba037fd99252bb4aa58"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3038 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3039 | <a name='Color_Filter_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3040 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3041 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3042 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3043 | <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] | 3044 | <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] | 3045 | 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] | 3046 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3047 | 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] | 3048 | |
| 3049 | ### Example |
| 3050 | |
| 3051 | <div><fiddle-embed name="5abde56ca2f89a18b8e231abd1b57c56"></fiddle-embed></div> |
| 3052 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3053 | <a name='SkPaint_getColorFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3054 | |
| 3055 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3056 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3057 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3058 | <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] | 3059 | </pre> |
| 3060 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3061 | Returns <a href='undocumented#Color_Filter'>Color Filter</a> if set, or nullptr. |
| 3062 | 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] | 3063 | |
| 3064 | ### Return Value |
| 3065 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3066 | <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] | 3067 | |
| 3068 | ### Example |
| 3069 | |
| 3070 | <div><fiddle-embed name="093bdc627d6b59002670fd290931f6c9"> |
| 3071 | |
| 3072 | #### Example Output |
| 3073 | |
| 3074 | ~~~~ |
| 3075 | nullptr == color filter |
| 3076 | nullptr != color filter |
| 3077 | ~~~~ |
| 3078 | |
| 3079 | </fiddle-embed></div> |
| 3080 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3081 | <a name='SkPaint_refColorFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3082 | |
| 3083 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3084 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3085 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3086 | <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] | 3087 | </pre> |
| 3088 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3089 | Returns <a href='undocumented#Color_Filter'>Color Filter</a> if set, or nullptr. |
| 3090 | 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] | 3091 | |
| 3092 | ### Return Value |
| 3093 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3094 | <a href='undocumented#Color_Filter'>Color Filter</a> if set, or nullptr |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3095 | |
| 3096 | ### Example |
| 3097 | |
| 3098 | <div><fiddle-embed name="b588c95fa4c86ddbc4b0546762f08297"> |
| 3099 | |
| 3100 | #### Example Output |
| 3101 | |
| 3102 | ~~~~ |
| 3103 | color filter unique: true |
| 3104 | color filter unique: false |
| 3105 | ~~~~ |
| 3106 | |
| 3107 | </fiddle-embed></div> |
| 3108 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3109 | <a name='SkPaint_setColorFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3110 | |
| 3111 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3112 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3113 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3114 | 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] | 3115 | </pre> |
| 3116 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3117 | Sets <a href='undocumented#Color_Filter'>Color Filter</a> to filter, decreasing <a href='undocumented#Reference_Count'>Reference Count</a> of the previous |
| 3118 | <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] | 3119 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3120 | Increments filter <a href='undocumented#Reference_Count'>Reference Count</a> by one. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3121 | |
| 3122 | ### Parameters |
| 3123 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3124 | <table> <tr> <td><a name='SkPaint_setColorFilter_colorFilter'><code><strong>colorFilter</strong></code></a></td> |
| 3125 | <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] | 3126 | </tr> |
| 3127 | </table> |
| 3128 | |
| 3129 | ### Example |
| 3130 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 3131 | <div><fiddle-embed name="c7b786dc9b3501cd0eaba47494b6fa31"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3132 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3133 | <a name='Blend_Mode_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3134 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3135 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3136 | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 3137 | <a href='SkBlendMode_Reference#Blend_Mode'>Blend Mode</a> describes how <a href='SkColor_Reference#Color'>Color</a> combines with the destination color. |
| 3138 | 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] | 3139 | over the destination color. |
| 3140 | |
| 3141 | ### Example |
| 3142 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 3143 | <div><fiddle-embed name="73092d4d06faecea3c204d852a4dd8a8"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3144 | |
| 3145 | ### See Also |
| 3146 | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 3147 | <a href='SkBlendMode_Reference#Blend_Mode'>Blend Mode</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3148 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3149 | <a name='SkPaint_getBlendMode'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3150 | |
| 3151 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3152 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3153 | <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] | 3154 | <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] | 3155 | </pre> |
| 3156 | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 3157 | Returns <a href='SkBlendMode_Reference#Blend_Mode'>Blend Mode</a>. |
| 3158 | By default, returns <a href='SkBlendMode_Reference#SkBlendMode_kSrcOver'>SkBlendMode::kSrcOver</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3159 | |
| 3160 | ### Return Value |
| 3161 | |
| 3162 | mode used to combine source color with destination color |
| 3163 | |
| 3164 | ### Example |
| 3165 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 3166 | <div><fiddle-embed name="a1e059c8f6740fa2044cc64152b39dda"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3167 | |
| 3168 | #### Example Output |
| 3169 | |
| 3170 | ~~~~ |
| 3171 | kSrcOver == getBlendMode |
| 3172 | kSrcOver != getBlendMode |
| 3173 | ~~~~ |
| 3174 | |
| 3175 | </fiddle-embed></div> |
| 3176 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3177 | <a name='SkPaint_isSrcOver'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3178 | |
| 3179 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3180 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3181 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3182 | bool <a href='#SkPaint_isSrcOver'>isSrcOver</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3183 | </pre> |
| 3184 | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 3185 | 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] | 3186 | |
| 3187 | ### Return Value |
| 3188 | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 3189 | 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] | 3190 | |
| 3191 | ### Example |
| 3192 | |
| 3193 | <div><fiddle-embed name="257c9473db7a2b3a0fb2b9e2431e59a6"> |
| 3194 | |
| 3195 | #### Example Output |
| 3196 | |
| 3197 | ~~~~ |
| 3198 | isSrcOver == true |
| 3199 | isSrcOver != true |
| 3200 | ~~~~ |
| 3201 | |
| 3202 | </fiddle-embed></div> |
| 3203 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3204 | <a name='SkPaint_setBlendMode'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3205 | |
| 3206 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3207 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3208 | <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] | 3209 | 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] | 3210 | </pre> |
| 3211 | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 3212 | 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] | 3213 | Does not check for valid input. |
| 3214 | |
| 3215 | ### Parameters |
| 3216 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3217 | <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] | 3218 | <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] | 3219 | </tr> |
| 3220 | </table> |
| 3221 | |
| 3222 | ### Example |
| 3223 | |
| 3224 | <div><fiddle-embed name="257c9473db7a2b3a0fb2b9e2431e59a6"> |
| 3225 | |
| 3226 | #### Example Output |
| 3227 | |
| 3228 | ~~~~ |
| 3229 | isSrcOver == true |
| 3230 | isSrcOver != true |
| 3231 | ~~~~ |
| 3232 | |
| 3233 | </fiddle-embed></div> |
| 3234 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3235 | <a name='Path_Effect_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3236 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3237 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3238 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3239 | <a href='undocumented#Path_Effect'>Path Effect</a> modifies the path geometry before drawing it. |
| 3240 | <a href='undocumented#Path_Effect'>Path Effect</a> may implement dashing, custom fill effects and custom stroke effects. |
| 3241 | 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] | 3242 | |
| 3243 | ### Example |
| 3244 | |
| 3245 | <div><fiddle-embed name="8cf5684b187d60f09e11c4a48993ea39"></fiddle-embed></div> |
| 3246 | |
| 3247 | ### See Also |
| 3248 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3249 | <a href='undocumented#Path_Effect'>Path Effect</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3250 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3251 | <a name='SkPaint_getPathEffect'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3252 | |
| 3253 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3254 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3255 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3256 | <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] | 3257 | </pre> |
| 3258 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3259 | Returns <a href='undocumented#Path_Effect'>Path Effect</a> if set, or nullptr. |
| 3260 | 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] | 3261 | |
| 3262 | ### Return Value |
| 3263 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3264 | <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] | 3265 | |
| 3266 | ### Example |
| 3267 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 3268 | <div><fiddle-embed name="211a1b14bfa6c4332082c8eab4fbc5fd"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3269 | |
| 3270 | #### Example Output |
| 3271 | |
| 3272 | ~~~~ |
| 3273 | nullptr == path effect |
| 3274 | nullptr != path effect |
| 3275 | ~~~~ |
| 3276 | |
| 3277 | </fiddle-embed></div> |
| 3278 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3279 | <a name='SkPaint_refPathEffect'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3280 | |
| 3281 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3282 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3283 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3284 | <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] | 3285 | </pre> |
| 3286 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3287 | Returns <a href='undocumented#Path_Effect'>Path Effect</a> if set, or nullptr. |
| 3288 | 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] | 3289 | |
| 3290 | ### Return Value |
| 3291 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3292 | <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] | 3293 | |
| 3294 | ### Example |
| 3295 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 3296 | <div><fiddle-embed name="f56039b94c702c2704c8c5100e623aca"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3297 | |
| 3298 | #### Example Output |
| 3299 | |
| 3300 | ~~~~ |
| 3301 | path effect unique: true |
| 3302 | path effect unique: false |
| 3303 | ~~~~ |
| 3304 | |
| 3305 | </fiddle-embed></div> |
| 3306 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3307 | <a name='SkPaint_setPathEffect'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3308 | |
| 3309 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3310 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3311 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3312 | 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] | 3313 | </pre> |
| 3314 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3315 | 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 |
| 3316 | <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] | 3317 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3318 | 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] | 3319 | |
| 3320 | ### Parameters |
| 3321 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3322 | <table> <tr> <td><a name='SkPaint_setPathEffect_pathEffect'><code><strong>pathEffect</strong></code></a></td> |
| 3323 | <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] | 3324 | </tr> |
| 3325 | </table> |
| 3326 | |
| 3327 | ### Example |
| 3328 | |
| 3329 | <div><fiddle-embed name="52dd55074ca0b7d520d04e750ca2a0d7"></fiddle-embed></div> |
| 3330 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3331 | <a name='Mask_Filter_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3332 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3333 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3334 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3335 | <a href='undocumented#Mask_Filter'>Mask Filter</a> uses coverage of the shape drawn to create <a href='undocumented#Mask_Alpha'>Mask Alpha</a>. |
| 3336 | <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] | 3337 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3338 | <a href='undocumented#Mask_Filter'>Mask Filter</a> may change the geometry and transparency of the shape, such as |
| 3339 | 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] | 3340 | modifying the draw. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3341 | |
| 3342 | ### Example |
| 3343 | |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 3344 | <div><fiddle-embed name="55d7b9d482ac8e17a6153f555a8adb8d"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3345 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3346 | <a name='SkPaint_getMaskFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3347 | |
| 3348 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3349 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3350 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3351 | <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] | 3352 | </pre> |
| 3353 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3354 | Returns <a href='undocumented#Mask_Filter'>Mask Filter</a> if set, or nullptr. |
| 3355 | 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] | 3356 | |
| 3357 | ### Return Value |
| 3358 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3359 | <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] | 3360 | |
| 3361 | ### Example |
| 3362 | |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 3363 | <div><fiddle-embed name="5ac4b31371726da87bb7390b385e9fee"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3364 | |
| 3365 | #### Example Output |
| 3366 | |
| 3367 | ~~~~ |
| 3368 | nullptr == mask filter |
| 3369 | nullptr != mask filter |
| 3370 | ~~~~ |
| 3371 | |
| 3372 | </fiddle-embed></div> |
| 3373 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3374 | <a name='SkPaint_refMaskFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3375 | |
| 3376 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3377 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3378 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3379 | <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] | 3380 | </pre> |
| 3381 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3382 | 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] | 3383 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3384 | 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] | 3385 | |
| 3386 | ### Return Value |
| 3387 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3388 | <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] | 3389 | |
| 3390 | ### Example |
| 3391 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 3392 | <div><fiddle-embed name="084b0dc3cebd78718c651d58f257f799"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3393 | |
| 3394 | #### Example Output |
| 3395 | |
| 3396 | ~~~~ |
| 3397 | mask filter unique: true |
| 3398 | mask filter unique: false |
| 3399 | ~~~~ |
| 3400 | |
| 3401 | </fiddle-embed></div> |
| 3402 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3403 | <a name='SkPaint_setMaskFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3404 | |
| 3405 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3406 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3407 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3408 | 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] | 3409 | </pre> |
| 3410 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3411 | 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 |
| 3412 | <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 |
| 3413 | <a href='undocumented#Mask_Alpha'>Mask Alpha</a> unaltered. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3414 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3415 | 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] | 3416 | |
| 3417 | ### Parameters |
| 3418 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3419 | <table> <tr> <td><a name='SkPaint_setMaskFilter_maskFilter'><code><strong>maskFilter</strong></code></a></td> |
| 3420 | <td>modifies clipping mask generated from drawn geometry</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3421 | </tr> |
| 3422 | </table> |
| 3423 | |
| 3424 | ### Example |
| 3425 | |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 3426 | <div><fiddle-embed name="a993831c40f3e134f809134e3b74e4a6"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3427 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3428 | <a name='Typeface_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3429 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3430 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3431 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3432 | <a href='undocumented#Typeface'>Typeface</a> identifies the font used when drawing and measuring text. |
| 3433 | <a href='undocumented#Typeface'>Typeface</a> may be specified by name, from a file, or from a data stream. |
| 3434 | 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] | 3435 | implementation. |
| 3436 | |
| 3437 | ### Example |
| 3438 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 3439 | <div><fiddle-embed name="1a7a5062725139760962582f599f1b97"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3440 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3441 | <a name='SkPaint_getTypeface'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3442 | |
| 3443 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3444 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3445 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3446 | <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] | 3447 | </pre> |
| 3448 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3449 | Returns <a href='undocumented#Typeface'>Typeface</a> if set, or nullptr. |
Cary Clark | 81abc43 | 2018-06-25 16:30:08 -0400 | [diff] [blame] | 3450 | 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] | 3451 | |
| 3452 | ### Return Value |
| 3453 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3454 | <a href='undocumented#Typeface'>Typeface</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3455 | |
| 3456 | ### Example |
| 3457 | |
Cary Clark | f960398 | 2018-07-17 08:20:27 -0400 | [diff] [blame] | 3458 | <div><fiddle-embed name="5ce718e5a184baaac80e7098d7dad67b"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3459 | |
| 3460 | #### Example Output |
| 3461 | |
| 3462 | ~~~~ |
| 3463 | nullptr == typeface |
| 3464 | nullptr != typeface |
| 3465 | ~~~~ |
| 3466 | |
| 3467 | </fiddle-embed></div> |
| 3468 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3469 | <a name='SkPaint_refTypeface'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3470 | |
| 3471 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3472 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3473 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3474 | <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] | 3475 | </pre> |
| 3476 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3477 | 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] | 3478 | |
| 3479 | ### Return Value |
| 3480 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3481 | <a href='undocumented#Typeface'>Typeface</a> if previously set, nullptr otherwise |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3482 | |
| 3483 | ### Example |
| 3484 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 3485 | <div><fiddle-embed name="8b5aa7e555a0dc31be69db7cadf471a1"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3486 | |
| 3487 | #### Example Output |
| 3488 | |
| 3489 | ~~~~ |
| 3490 | typeface1 != typeface2 |
| 3491 | typeface1 == typeface2 |
| 3492 | ~~~~ |
| 3493 | |
| 3494 | </fiddle-embed></div> |
| 3495 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3496 | <a name='SkPaint_setTypeface'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3497 | |
| 3498 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3499 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3500 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3501 | 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] | 3502 | </pre> |
| 3503 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3504 | 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>. |
| 3505 | Pass nullptr to clear <a href='undocumented#Typeface'>Typeface</a> and use the default <a href='#SkPaint_setTypeface_typeface'>typeface</a>. Increments |
| 3506 | <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] | 3507 | |
| 3508 | ### Parameters |
| 3509 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3510 | <table> <tr> <td><a name='SkPaint_setTypeface_typeface'><code><strong>typeface</strong></code></a></td> |
| 3511 | <td>font and style used to draw text</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3512 | </tr> |
| 3513 | </table> |
| 3514 | |
| 3515 | ### Example |
| 3516 | |
Cary Clark | 71961fb | 2018-01-05 14:21:59 -0500 | [diff] [blame] | 3517 | <div><fiddle-embed name="0e6fbb7773cd925b274552f4cd1abef2"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3518 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3519 | <a name='Image_Filter_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3520 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3521 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3522 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3523 | <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] | 3524 | 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, |
| 3525 | 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] | 3526 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3527 | <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> |
| 3528 | 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. |
| 3529 | <a href='undocumented#Image_Filter'>Image Filter</a> operates independently of and can be used in combination with |
| 3530 | <a href='undocumented#Mask_Filter'>Mask Filter</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3531 | |
| 3532 | ### Example |
| 3533 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 3534 | <div><fiddle-embed name="ece04ee3d3761e3425f37c8f06f054c1"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3535 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3536 | <a name='SkPaint_getImageFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3537 | |
| 3538 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3539 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3540 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3541 | <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] | 3542 | </pre> |
| 3543 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3544 | Returns <a href='undocumented#Image_Filter'>Image Filter</a> if set, or nullptr. |
| 3545 | 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] | 3546 | |
| 3547 | ### Return Value |
| 3548 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3549 | <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] | 3550 | |
| 3551 | ### Example |
| 3552 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 3553 | <div><fiddle-embed name="c11f8eaa1dd149bc18db21e23ce26904"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3554 | |
| 3555 | #### Example Output |
| 3556 | |
| 3557 | ~~~~ |
| 3558 | nullptr == image filter |
| 3559 | nullptr != image filter |
| 3560 | ~~~~ |
| 3561 | |
| 3562 | </fiddle-embed></div> |
| 3563 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3564 | <a name='SkPaint_refImageFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3565 | |
| 3566 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3567 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3568 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3569 | <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] | 3570 | </pre> |
| 3571 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3572 | Returns <a href='undocumented#Image_Filter'>Image Filter</a> if set, or nullptr. |
| 3573 | 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] | 3574 | |
| 3575 | ### Return Value |
| 3576 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3577 | <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] | 3578 | |
| 3579 | ### Example |
| 3580 | |
| 3581 | <div><fiddle-embed name="13f09088b569251547107d14ae989dc1"> |
| 3582 | |
| 3583 | #### Example Output |
| 3584 | |
| 3585 | ~~~~ |
| 3586 | image filter unique: true |
| 3587 | image filter unique: false |
| 3588 | ~~~~ |
| 3589 | |
| 3590 | </fiddle-embed></div> |
| 3591 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3592 | <a name='SkPaint_setImageFilter'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3593 | |
| 3594 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3595 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3596 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3597 | 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] | 3598 | </pre> |
| 3599 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3600 | 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 |
| 3601 | <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] | 3602 | on drawing. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3603 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3604 | 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] | 3605 | |
| 3606 | ### Parameters |
| 3607 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3608 | <table> <tr> <td><a name='SkPaint_setImageFilter_imageFilter'><code><strong>imageFilter</strong></code></a></td> |
| 3609 | <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] | 3610 | </tr> |
| 3611 | </table> |
| 3612 | |
| 3613 | ### Example |
| 3614 | |
| 3615 | <div><fiddle-embed name="6679d6e4ec632715ee03e68391bd7f9a"></fiddle-embed></div> |
| 3616 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3617 | <a name='Draw_Looper_Methods'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3618 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3619 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3620 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3621 | <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] | 3622 | to another to construct the draw. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3623 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3624 | <a href='undocumented#Draw_Looper'>Draw Looper</a> draws one or more times, modifying the canvas and paint each time. |
| 3625 | <a href='undocumented#Draw_Looper'>Draw Looper</a> may be used to draw multiple colors or create a colored shadow. |
| 3626 | 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] | 3627 | |
| 3628 | ### Example |
| 3629 | |
| 3630 | <div><fiddle-embed name="84ec12a36e50df5ac565cc7a75ffbe9f"></fiddle-embed></div> |
| 3631 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3632 | <a name='SkPaint_getDrawLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3633 | |
| 3634 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3635 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3636 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3637 | <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] | 3638 | </pre> |
| 3639 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3640 | Returns <a href='undocumented#Draw_Looper'>Draw Looper</a> if set, or nullptr. |
| 3641 | 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] | 3642 | |
| 3643 | ### Return Value |
| 3644 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3645 | <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] | 3646 | |
| 3647 | ### Example |
| 3648 | |
| 3649 | <div><fiddle-embed name="af4c5acc7a91e7f23c2af48018903ad4"> |
| 3650 | |
| 3651 | #### Example Output |
| 3652 | |
| 3653 | ~~~~ |
| 3654 | nullptr == draw looper |
| 3655 | nullptr != draw looper |
| 3656 | ~~~~ |
| 3657 | |
| 3658 | </fiddle-embed></div> |
| 3659 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3660 | <a name='SkPaint_refDrawLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3661 | |
| 3662 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3663 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3664 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3665 | <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] | 3666 | </pre> |
| 3667 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3668 | Returns <a href='undocumented#Draw_Looper'>Draw Looper</a> if set, or nullptr. |
| 3669 | 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] | 3670 | |
| 3671 | ### Return Value |
| 3672 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3673 | <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] | 3674 | |
| 3675 | ### Example |
| 3676 | |
| 3677 | <div><fiddle-embed name="2a3782c33f04ed17a725d0e449c6f7c3"> |
| 3678 | |
| 3679 | #### Example Output |
| 3680 | |
| 3681 | ~~~~ |
| 3682 | draw looper unique: true |
| 3683 | draw looper unique: false |
| 3684 | ~~~~ |
| 3685 | |
| 3686 | </fiddle-embed></div> |
| 3687 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3688 | <a name='SkPaint_getLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3689 | |
| 3690 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3691 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3692 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3693 | <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] | 3694 | </pre> |
| 3695 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3696 | Deprecated. |
| 3697 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3698 | <a name='SkPaint_setDrawLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3699 | |
| 3700 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3701 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3702 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3703 | 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] | 3704 | </pre> |
| 3705 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3706 | 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 |
| 3707 | <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] | 3708 | drawing unaltered. |
| 3709 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3710 | 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] | 3711 | |
| 3712 | ### Parameters |
| 3713 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3714 | <table> <tr> <td><a name='SkPaint_setDrawLooper_drawLooper'><code><strong>drawLooper</strong></code></a></td> |
| 3715 | <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] | 3716 | </tr> |
| 3717 | </table> |
| 3718 | |
| 3719 | ### Example |
| 3720 | |
| 3721 | <div><fiddle-embed name="bf10f838b330f0a3a3266d42ea68a638"></fiddle-embed></div> |
| 3722 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3723 | <a name='SkPaint_setLooper'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3724 | |
| 3725 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3726 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3727 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3728 | 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] | 3729 | </pre> |
| 3730 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3731 | Deprecated. |
| 3732 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3733 | <a name='Text_Align'></a> |
| 3734 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3735 | --- |
| 3736 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3737 | <a name='SkPaint_Align'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3738 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3739 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3740 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 3741 | <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] | 3742 | enum <a href='#SkPaint_Align'>Align</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 3743 | <a href='#SkPaint_kLeft_Align'>kLeft_Align</a>, |
| 3744 | <a href='#SkPaint_kCenter_Align'>kCenter_Align</a>, |
| 3745 | <a href='#SkPaint_kRight_Align'>kRight_Align</a>, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 3746 | }; |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3747 | </pre> |
Cary Clark | d98f78c | 2018-04-26 08:32:37 -0400 | [diff] [blame] | 3748 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3749 | <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] | 3750 | static constexpr int <a href='#SkPaint_kAlignCount'>kAlignCount</a> = 3; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3751 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3752 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3753 | <a href='#SkPaint_Align'>Align</a> adjusts the text relative to the text position. |
| 3754 | <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] | 3755 | <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] | 3756 | and <a href='SkCanvas_Reference#SkCanvas_drawString'>SkCanvas::drawString</a>; |
| 3757 | 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] | 3758 | |
| 3759 | The text position is set by the font for both horizontal and vertical text. |
| 3760 | Typically, for horizontal text, the position is to the left side of the glyph on the |
| 3761 | base line; and for vertical text, the position is the horizontal center of the glyph |
| 3762 | at the caps height. |
| 3763 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3764 | <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] | 3765 | using the metrics returned by the font. |
| 3766 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3767 | <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] | 3768 | |
| 3769 | ### Constants |
| 3770 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3771 | <table style='border-collapse: collapse; width: 62.5em'> |
| 3772 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 3773 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 3774 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 3775 | <tr style='background-color: #f0f0f0; '> |
| 3776 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kLeft_Align'><code>SkPaint::kLeft_Align</code></a></td> |
| 3777 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 3778 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 3779 | 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] | 3780 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3781 | </tr> |
| 3782 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3783 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kCenter_Align'><code>SkPaint::kCenter_Align</code></a></td> |
| 3784 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 3785 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 3786 | Moves the glyph half its width if <a href='#SkPaint_Flags'>Flags</a> has <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> clear, and |
| 3787 | half its height if <a href='#SkPaint_Flags'>Flags</a> has <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> set. |
| 3788 | </td> |
| 3789 | </tr> |
| 3790 | <tr style='background-color: #f0f0f0; '> |
| 3791 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kRight_Align'><code>SkPaint::kRight_Align</code></a></td> |
| 3792 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 3793 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 3794 | Moves the glyph by its width if <a href='#SkPaint_Flags'>Flags</a> has <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> clear, |
| 3795 | and by its height if <a href='#SkPaint_Flags'>Flags</a> has <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> set. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3796 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3797 | </tr> |
| 3798 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3799 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kAlignCount'><code>SkPaint::kAlignCount</code></a></td> |
| 3800 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 3801 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 3802 | May be used to verify that <a href='#SkPaint_Align'>Align</a> is a legal value. |
| 3803 | </td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3804 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3805 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3806 | |
| 3807 | ### Example |
| 3808 | |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3809 | <div><fiddle-embed name="702617fd9ebc3f12e30081b5db93e8a8"><div>Each position separately moves the glyph in drawPosText. |
| 3810 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3811 | |
| 3812 | ### Example |
| 3813 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3814 | <div><fiddle-embed name="f1cbbbafe6b3c52b81309cccbf96a308"><div><a href='#Vertical_Text'>Vertical Text</a> treats <a href='#SkPaint_kLeft_Align'>kLeft Align</a> as top align, and <a href='#SkPaint_kRight_Align'>kRight Align</a> as bottom align. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 3815 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3816 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3817 | <a name='SkPaint_getTextAlign'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3818 | |
| 3819 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3820 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3821 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3822 | <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] | 3823 | </pre> |
| 3824 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3825 | Returns <a href='#Text_Align'>Text Align</a>. |
| 3826 | 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] | 3827 | |
| 3828 | ### Return Value |
| 3829 | |
| 3830 | text placement relative to position |
| 3831 | |
| 3832 | ### Example |
| 3833 | |
| 3834 | <div><fiddle-embed name="2df932f526e810f74c89d30ec3f4c947"> |
| 3835 | |
| 3836 | #### Example Output |
| 3837 | |
| 3838 | ~~~~ |
| 3839 | kLeft_Align == default |
| 3840 | ~~~~ |
| 3841 | |
| 3842 | </fiddle-embed></div> |
| 3843 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3844 | <a name='SkPaint_setTextAlign'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3845 | |
| 3846 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3847 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3848 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3849 | 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] | 3850 | </pre> |
| 3851 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3852 | Sets <a href='#Text_Align'>Text Align</a> to <a href='#SkPaint_setTextAlign_align'>align</a>. |
| 3853 | 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] | 3854 | |
| 3855 | ### Parameters |
| 3856 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3857 | <table> <tr> <td><a name='SkPaint_setTextAlign_align'><code><strong>align</strong></code></a></td> |
| 3858 | <td>text placement relative to position</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3859 | </tr> |
| 3860 | </table> |
| 3861 | |
| 3862 | ### Example |
| 3863 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3864 | <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] | 3865 | alignment out of range has no effect. |
| 3866 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3867 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3868 | <a name='Text_Size'></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_Size'>Text Size</a> adjusts the overall text size in points. |
| 3873 | <a href='#Text_Size'>Text Size</a> can be set to any positive value or zero. |
| 3874 | <a href='#Text_Size'>Text Size</a> defaults to 12. |
| 3875 | 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] | 3876 | |
| 3877 | ### Example |
| 3878 | |
| 3879 | <div><fiddle-embed name="91c9a3e498bb9412e4522a95d076ed5f"></fiddle-embed></div> |
| 3880 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3881 | <a name='SkPaint_getTextSize'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3882 | |
| 3883 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3884 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3885 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3886 | <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] | 3887 | </pre> |
| 3888 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3889 | Returns <a href='#Text_Size'>Text Size</a> in points. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3890 | |
| 3891 | ### Return Value |
| 3892 | |
| 3893 | typographic height of text |
| 3894 | |
| 3895 | ### Example |
| 3896 | |
skia-bookmaker | 233c652 | 2018-07-04 05:33:26 +0000 | [diff] [blame] | 3897 | <div><fiddle-embed name="983e2a71ba72d4ba8c945420040b8f1c"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3898 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3899 | <a name='SkPaint_setTextSize'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3900 | |
| 3901 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3902 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3903 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3904 | 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] | 3905 | </pre> |
| 3906 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3907 | Sets <a href='#Text_Size'>Text Size</a> in points. |
| 3908 | 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] | 3909 | |
| 3910 | ### Parameters |
| 3911 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3912 | <table> <tr> <td><a name='SkPaint_setTextSize_textSize'><code><strong>textSize</strong></code></a></td> |
| 3913 | <td>typographic height of text</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3914 | </tr> |
| 3915 | </table> |
| 3916 | |
| 3917 | ### Example |
| 3918 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 3919 | <div><fiddle-embed name="6510c9e2f57b83c47e67829e7a68d493"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3920 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3921 | <a name='Text_Scale_X'></a> |
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 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3924 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3925 | <a href='#Text_Scale_X'>Text Scale X</a> adjusts the text horizontal scale. |
| 3926 | <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] | 3927 | is not available. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3928 | <a href='#Text_Scale_X'>Text Scale X</a> can be set to any value. |
| 3929 | <a href='#Text_Scale_X'>Text Scale X</a> defaults to 1. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3930 | |
| 3931 | ### Example |
| 3932 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 3933 | <div><fiddle-embed name="d13d787c1e36f515319fc998411c1d91"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3934 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3935 | <a name='SkPaint_getTextScaleX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3936 | |
| 3937 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3938 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3939 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3940 | <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] | 3941 | </pre> |
| 3942 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3943 | Returns <a href='#Text_Scale_X'>Text Scale X</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3944 | Default value is 1. |
| 3945 | |
| 3946 | ### Return Value |
| 3947 | |
| 3948 | text horizontal scale |
| 3949 | |
| 3950 | ### Example |
| 3951 | |
| 3952 | <div><fiddle-embed name="5dc8e58f6910cb8e4de9ed60f888188b"></fiddle-embed></div> |
| 3953 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3954 | <a name='SkPaint_setTextScaleX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3955 | |
| 3956 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3957 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3958 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3959 | 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] | 3960 | </pre> |
| 3961 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3962 | Sets <a href='#Text_Scale_X'>Text Scale X</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3963 | Default value is 1. |
| 3964 | |
| 3965 | ### Parameters |
| 3966 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3967 | <table> <tr> <td><a name='SkPaint_setTextScaleX_scaleX'><code><strong>scaleX</strong></code></a></td> |
| 3968 | <td>text horizontal scale</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3969 | </tr> |
| 3970 | </table> |
| 3971 | |
| 3972 | ### Example |
| 3973 | |
| 3974 | <div><fiddle-embed name="a75bbdb8bb866b125c4c1dd5e967d470"></fiddle-embed></div> |
| 3975 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3976 | <a name='Text_Skew_X'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3977 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3978 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3979 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3980 | <a href='#Text_Skew_X'>Text Skew X</a> adjusts the text horizontal slant. |
| 3981 | <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] | 3982 | is not available. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3983 | <a href='#Text_Skew_X'>Text Skew X</a> can be set to any value. |
| 3984 | <a href='#Text_Skew_X'>Text Skew X</a> defaults to 0. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3985 | |
| 3986 | ### Example |
| 3987 | |
| 3988 | <div><fiddle-embed name="aff208b0aab265f273045b27e683c17c"></fiddle-embed></div> |
| 3989 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3990 | <a name='SkPaint_getTextSkewX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 3991 | |
| 3992 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3993 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3994 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 3995 | <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] | 3996 | </pre> |
| 3997 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3998 | Returns <a href='#Text_Skew_X'>Text Skew X</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 3999 | Default value is zero. |
| 4000 | |
| 4001 | ### Return Value |
| 4002 | |
| 4003 | additional shear in x-axis relative to y-axis |
| 4004 | |
| 4005 | ### Example |
| 4006 | |
Cary Clark | 7f644ec | 2018-07-19 10:50:44 -0400 | [diff] [blame] | 4007 | <div><fiddle-embed name="11c10f466dae0d1639dbb9f6a0040218"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4008 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4009 | <a name='SkPaint_setTextSkewX'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4010 | |
| 4011 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4012 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4013 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4014 | 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] | 4015 | </pre> |
| 4016 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4017 | Sets <a href='#Text_Skew_X'>Text Skew X</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4018 | Default value is zero. |
| 4019 | |
| 4020 | ### Parameters |
| 4021 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4022 | <table> <tr> <td><a name='SkPaint_setTextSkewX_skewX'><code><strong>skewX</strong></code></a></td> |
| 4023 | <td>additional shear in x-axis relative to y-axis</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4024 | </tr> |
| 4025 | </table> |
| 4026 | |
| 4027 | ### Example |
| 4028 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 4029 | <div><fiddle-embed name="6bd705a6e0c5f8ee24f302fe531bfabc"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4030 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4031 | <a name='Text_Encoding'></a> |
| 4032 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4033 | --- |
| 4034 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4035 | <a name='SkPaint_TextEncoding'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4036 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4037 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4038 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 4039 | <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] | 4040 | enum <a href='#SkPaint_TextEncoding'>TextEncoding</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4041 | <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8_TextEncoding</a>, |
| 4042 | <a href='#SkPaint_kUTF16_TextEncoding'>kUTF16_TextEncoding</a>, |
| 4043 | <a href='#SkPaint_kUTF32_TextEncoding'>kUTF32_TextEncoding</a>, |
| 4044 | <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID_TextEncoding</a>, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 4045 | }; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4046 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4047 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4048 | <a href='#SkPaint_TextEncoding'>TextEncoding</a> determines whether text specifies character codes and their encoded |
| 4049 | 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] | 4050 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 4051 | 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] | 4052 | 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] | 4053 | in the total storage required. |
| 4054 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4055 | <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] | 4056 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4057 | <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] | 4058 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4059 | <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] | 4060 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4061 | <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] | 4062 | A glyph index is a 16-bit word. |
| 4063 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4064 | <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] | 4065 | |
| 4066 | ### Constants |
| 4067 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4068 | <table style='border-collapse: collapse; width: 62.5em'> |
| 4069 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 4070 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 4071 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 4072 | <tr style='background-color: #f0f0f0; '> |
| 4073 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kUTF8_TextEncoding'><code>SkPaint::kUTF8_TextEncoding</code></a></td> |
| 4074 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0</td> |
| 4075 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4076 | uses bytes to represent UTF-8 or ASCII</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4077 | </tr> |
| 4078 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4079 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kUTF16_TextEncoding'><code>SkPaint::kUTF16_TextEncoding</code></a></td> |
| 4080 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>1</td> |
| 4081 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4082 | uses two byte words to represent most of Unicode</td> |
| 4083 | </tr> |
| 4084 | <tr style='background-color: #f0f0f0; '> |
| 4085 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kUTF32_TextEncoding'><code>SkPaint::kUTF32_TextEncoding</code></a></td> |
| 4086 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>2</td> |
| 4087 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4088 | uses four byte words to represent all of Unicode</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4089 | </tr> |
| 4090 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4091 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_kGlyphID_TextEncoding'><code>SkPaint::kGlyphID_TextEncoding</code></a></td> |
| 4092 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>3</td> |
| 4093 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4094 | uses two byte words to represent glyph indices</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4095 | </tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4096 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4097 | |
| 4098 | ### Example |
| 4099 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 4100 | <div><fiddle-embed name="b29294e7f29d160a1b46abf2dcec9d2a"><div>First line is encoded in UTF-8. |
| 4101 | Second line is encoded in UTF-16. |
| 4102 | Third line is encoded in UTF-32. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4103 | Fourth line has 16-bit glyph indices. |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4104 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4105 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4106 | <a name='SkPaint_getTextEncoding'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4107 | |
| 4108 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4109 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4110 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4111 | <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] | 4112 | </pre> |
| 4113 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4114 | Returns <a href='#Text_Encoding'>Text Encoding</a>. |
| 4115 | <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] | 4116 | |
| 4117 | ### Return Value |
| 4118 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4119 | 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 |
| 4120 | <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID TextEncoding</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4121 | |
| 4122 | ### Example |
| 4123 | |
skia-bookmaker | 525f9a9 | 2018-05-03 06:27:39 +0000 | [diff] [blame] | 4124 | <div><fiddle-embed name="c6cc2780a9828b3af8c4621c12b29a1b"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4125 | |
| 4126 | #### Example Output |
| 4127 | |
| 4128 | ~~~~ |
| 4129 | kUTF8_TextEncoding == text encoding |
| 4130 | kGlyphID_TextEncoding == text encoding |
| 4131 | ~~~~ |
| 4132 | |
| 4133 | </fiddle-embed></div> |
| 4134 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4135 | <a name='SkPaint_setTextEncoding'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4136 | |
| 4137 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4138 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4139 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4140 | 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] | 4141 | </pre> |
| 4142 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4143 | Sets <a href='#Text_Encoding'>Text Encoding</a> to <a href='#SkPaint_setTextEncoding_encoding'>encoding</a>. |
| 4144 | <a href='#Text_Encoding'>Text Encoding</a> determines how character code points are mapped to font glyph indices. |
| 4145 | Invalid values for <a href='#SkPaint_setTextEncoding_encoding'>encoding</a> are ignored. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4146 | |
| 4147 | ### Parameters |
| 4148 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4149 | <table> <tr> <td><a name='SkPaint_setTextEncoding_encoding'><code><strong>encoding</strong></code></a></td> |
| 4150 | <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 |
| 4151 | <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID TextEncoding</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4152 | </tr> |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4153 | # |
| 4154 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4155 | </table> |
| 4156 | |
| 4157 | ### Example |
| 4158 | |
Cary Clark | 75fd449 | 2018-06-20 12:45:16 -0400 | [diff] [blame] | 4159 | <div><fiddle-embed name="6d9ffdd3c5543e9f12972a06dd4a0ce5"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4160 | |
| 4161 | #### Example Output |
| 4162 | |
| 4163 | ~~~~ |
| 4164 | 4 != text encoding |
| 4165 | ~~~~ |
| 4166 | |
| 4167 | </fiddle-embed></div> |
| 4168 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4169 | <a name='Font_Metrics'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4170 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4171 | --- |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 4172 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4173 | <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>. |
| 4174 | The dimensions are computed by <a href='undocumented#Font_Manager'>Font Manager</a> from font data and do not take |
| 4175 | <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] | 4176 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4177 | <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] | 4178 | X-axis values to the left of the glyph are negative, and to the right of the left glyph edge |
| 4179 | are positive. |
| 4180 | Y-axis values above the baseline are negative, and below the baseline are positive. |
| 4181 | |
| 4182 | ### Example |
| 4183 | |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4184 | <div><fiddle-embed name="2bfa3783719fcd769af177a1b244e171"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4185 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4186 | <a name='SkPaint_FontMetrics'></a> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4187 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4188 | --- |
| 4189 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 4190 | <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] | 4191 | struct <a href='#SkPaint_FontMetrics'>FontMetrics</a> { |
| 4192 | enum <a href='#SkPaint_FontMetrics_FontMetricsFlags'>FontMetricsFlags</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4193 | <a href='#SkPaint_FontMetrics_kUnderlineThicknessIsValid_Flag'>kUnderlineThicknessIsValid_Flag</a> = 1 << 0, |
| 4194 | <a href='#SkPaint_FontMetrics_kUnderlinePositionIsValid_Flag'>kUnderlinePositionIsValid_Flag</a> = 1 << 1, |
| 4195 | <a href='#SkPaint_FontMetrics_kStrikeoutThicknessIsValid_Flag'>kStrikeoutThicknessIsValid_Flag</a> = 1 << 2, |
| 4196 | <a href='#SkPaint_FontMetrics_kStrikeoutPositionIsValid_Flag'>kStrikeoutPositionIsValid_Flag</a> = 1 << 3, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 4197 | }; |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4198 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4199 | uint32_t <a href='#SkPaint_FontMetrics_fFlags'>fFlags</a>; |
| 4200 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fTop'>fTop</a>; |
| 4201 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fAscent'>fAscent</a>; |
| 4202 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fDescent'>fDescent</a>; |
| 4203 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fBottom'>fBottom</a>; |
| 4204 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fLeading'>fLeading</a>; |
| 4205 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fAvgCharWidth'>fAvgCharWidth</a>; |
| 4206 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fMaxCharWidth'>fMaxCharWidth</a>; |
| 4207 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fXMin'>fXMin</a>; |
| 4208 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fXMax'>fXMax</a>; |
| 4209 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fXHeight'>fXHeight</a>; |
| 4210 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fCapHeight'>fCapHeight</a>; |
| 4211 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fUnderlineThickness'>fUnderlineThickness</a>; |
| 4212 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fUnderlinePosition'>fUnderlinePosition</a>; |
| 4213 | <a href='undocumented#SkScalar'>SkScalar</a> <a href='#SkPaint_FontMetrics_fStrikeoutThickness'>fStrikeoutThickness</a>; |
| 4214 | <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] | 4215 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4216 | bool <a href='#SkPaint_FontMetrics_hasUnderlineThickness'>hasUnderlineThickness</a>(<a href='undocumented#SkScalar'>SkScalar</a>* thickness) const; |
| 4217 | bool <a href='#SkPaint_FontMetrics_hasUnderlinePosition'>hasUnderlinePosition</a>(<a href='undocumented#SkScalar'>SkScalar</a>* position) const; |
| 4218 | bool <a href='#SkPaint_FontMetrics_hasStrikeoutThickness'>hasStrikeoutThickness</a>(<a href='undocumented#SkScalar'>SkScalar</a>* thickness) const; |
| 4219 | 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] | 4220 | }; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4221 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4222 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4223 | <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 |
| 4224 | 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] | 4225 | not available. |
| 4226 | |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 4227 | All vertical values are relative to the baseline, on a y-axis pointing down. |
| 4228 | Zero is on the baseline, negative values are above the baseline, and positive |
| 4229 | values are below the baseline. |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4230 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4231 | <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] | 4232 | are valid, since their value may be zero. |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4233 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4234 | <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] | 4235 | are valid, since their value may be zero. |
| 4236 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4237 | <a name='SkPaint_FontMetrics_FontMetricsFlags'></a> |
| 4238 | |
| 4239 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4240 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 4241 | <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] | 4242 | enum <a href='#SkPaint_FontMetrics_FontMetricsFlags'>FontMetricsFlags</a> { |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4243 | <a href='#SkPaint_FontMetrics_kUnderlineThicknessIsValid_Flag'>kUnderlineThicknessIsValid_Flag</a> = 1 << 0, |
| 4244 | <a href='#SkPaint_FontMetrics_kUnderlinePositionIsValid_Flag'>kUnderlinePositionIsValid_Flag</a> = 1 << 1, |
| 4245 | <a href='#SkPaint_FontMetrics_kStrikeoutThicknessIsValid_Flag'>kStrikeoutThicknessIsValid_Flag</a> = 1 << 2, |
| 4246 | <a href='#SkPaint_FontMetrics_kStrikeoutPositionIsValid_Flag'>kStrikeoutPositionIsValid_Flag</a> = 1 << 3, |
Cary Clark | 186d08f | 2018-04-03 08:43:27 -0400 | [diff] [blame] | 4247 | }; |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 4248 | </pre> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4249 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4250 | <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] | 4251 | the underline or strikeout metric may be valid and zero. |
| 4252 | Fonts with embedded bitmaps may not have valid underline or strikeout metrics. |
| 4253 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4254 | ### Constants |
| 4255 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4256 | <table style='border-collapse: collapse; width: 62.5em'> |
| 4257 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Const</th> |
| 4258 | <th style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>Value</th> |
| 4259 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 4260 | <tr style='background-color: #f0f0f0; '> |
| 4261 | <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> |
| 4262 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0001</td> |
| 4263 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4264 | set if fUnderlineThickness is valid</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4265 | </tr> |
| 4266 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4267 | <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> |
| 4268 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0002</td> |
| 4269 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4270 | set if fUnderlinePosition is valid</td> |
| 4271 | </tr> |
| 4272 | <tr style='background-color: #f0f0f0; '> |
| 4273 | <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> |
| 4274 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0004</td> |
| 4275 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4276 | set if fStrikeoutThickness is valid</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4277 | </tr> |
| 4278 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4279 | <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> |
| 4280 | <td style='text-align: center; border: 2px solid #dddddd; padding: 8px; '>0x0008</td> |
| 4281 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4282 | set if fStrikeoutPosition is valid</td> |
| 4283 | </tr> |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 4284 | </table><table style='border-collapse: collapse; width: 62.5em'> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4285 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4286 | <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] | 4287 | <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] | 4288 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 4289 | <tr style='background-color: #f0f0f0; '> |
| 4290 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>uint32_t</td> |
| 4291 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fFlags'><code>fFlags</code></a></td> |
| 4292 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4293 | is set to FontMetricsFlags when metrics are valid</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4294 | </tr> |
| 4295 | <tr> |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4296 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4297 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fTop'><code>fTop</code></a></td> |
| 4298 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4299 | Greatest extent above the baseline for any glyph. |
| 4300 | Typically less than zero. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4301 | </td> |
| 4302 | </tr> |
| 4303 | <tr style='background-color: #f0f0f0; '> |
| 4304 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4305 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fAscent'><code>fAscent</code></a></td> |
| 4306 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4307 | Recommended distance above the baseline to reserve for a line of text. |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4308 | Typically less than zero. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4309 | </td> |
| 4310 | </tr> |
| 4311 | <tr> |
| 4312 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4313 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fDescent'><code>fDescent</code></a></td> |
| 4314 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4315 | Recommended distance below the baseline to reserve for a line of text. |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4316 | Typically greater than zero. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4317 | </td> |
| 4318 | </tr> |
| 4319 | <tr style='background-color: #f0f0f0; '> |
| 4320 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4321 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fBottom'><code>fBottom</code></a></td> |
| 4322 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4323 | Greatest extent below the baseline for any glyph. |
| 4324 | Typically greater than zero. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4325 | </td> |
| 4326 | </tr> |
| 4327 | <tr> |
| 4328 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4329 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fLeading'><code>fLeading</code></a></td> |
| 4330 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4331 | Recommended distance to add between lines of text. |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4332 | Typically greater than or equal to zero. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4333 | </td> |
| 4334 | </tr> |
| 4335 | <tr style='background-color: #f0f0f0; '> |
| 4336 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4337 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fAvgCharWidth'><code>fAvgCharWidth</code></a></td> |
| 4338 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4339 | Average character width, if it is available. |
| 4340 | Zero if no average width is stored in the font. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4341 | </td> |
| 4342 | </tr> |
| 4343 | <tr> |
| 4344 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4345 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fMaxCharWidth'><code>fMaxCharWidth</code></a></td> |
| 4346 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4347 | maximum character width</td> |
| 4348 | </tr> |
| 4349 | <tr style='background-color: #f0f0f0; '> |
| 4350 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4351 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fXMin'><code>fXMin</code></a></td> |
| 4352 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 4353 | 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] | 4354 | Typically less than zero. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4355 | </td> |
| 4356 | </tr> |
| 4357 | <tr> |
| 4358 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4359 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fXMax'><code>fXMax</code></a></td> |
| 4360 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 4361 | 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] | 4362 | Typically greater than zero. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4363 | </td> |
| 4364 | </tr> |
| 4365 | <tr style='background-color: #f0f0f0; '> |
| 4366 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4367 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fXHeight'><code>fXHeight</code></a></td> |
| 4368 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4369 | 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] | 4370 | </td> |
| 4371 | </tr> |
| 4372 | <tr> |
| 4373 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4374 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fCapHeight'><code>fCapHeight</code></a></td> |
| 4375 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4376 | 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] | 4377 | </td> |
| 4378 | </tr> |
| 4379 | <tr style='background-color: #f0f0f0; '> |
| 4380 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4381 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fUnderlineThickness'><code>fUnderlineThickness</code></a></td> |
| 4382 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4383 | 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>. |
| 4384 | If <a href='#SkPaint_FontMetrics_kUnderlineThicknessIsValid_Flag'>kUnderlineThicknessIsValid Flag</a> is clear, <a href='#SkPaint_FontMetrics_fUnderlineThickness'>fUnderlineThickness</a> is zero. |
| 4385 | </td> |
| 4386 | </tr> |
| 4387 | <tr> |
| 4388 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4389 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fUnderlinePosition'><code>fUnderlinePosition</code></a></td> |
| 4390 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4391 | Position of the top of the underline stroke relative to the baseline. |
| 4392 | Typically positive when valid. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4393 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4394 | 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>. |
| 4395 | If <a href='#SkPaint_FontMetrics_kUnderlinePositionIsValid_Flag'>kUnderlinePositionIsValid Flag</a> is clear, <a href='#SkPaint_FontMetrics_fUnderlinePosition'>fUnderlinePosition</a> is zero. |
| 4396 | </td> |
| 4397 | </tr> |
| 4398 | <tr style='background-color: #f0f0f0; '> |
| 4399 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4400 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fStrikeoutThickness'><code>fStrikeoutThickness</code></a></td> |
| 4401 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 4402 | 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>. |
| 4403 | If <a href='#SkPaint_FontMetrics_kStrikeoutThicknessIsValid_Flag'>kStrikeoutThicknessIsValid Flag</a> is clear, <a href='#SkPaint_FontMetrics_fStrikeoutThickness'>fStrikeoutThickness</a> is zero. |
| 4404 | </td> |
| 4405 | </tr> |
| 4406 | <tr> |
| 4407 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>SkScalar</td> |
| 4408 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkPaint_FontMetrics_fStrikeoutPosition'><code>fStrikeoutPosition</code></a></td> |
| 4409 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
Ben Wagner | e580649 | 2017-11-09 12:08:31 -0500 | [diff] [blame] | 4410 | Position of the bottom of the strikeout stroke relative to the baseline. |
| 4411 | Typically negative when valid. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4412 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4413 | 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>. |
| 4414 | If <a href='#SkPaint_FontMetrics_kStrikeoutPositionIsValid_Flag'>kStrikeoutPositionIsValid Flag</a> is clear, <a href='#SkPaint_FontMetrics_fStrikeoutPosition'>fStrikeoutPosition</a> is zero. |
| 4415 | </td> |
| 4416 | </tr> |
| 4417 | </table> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4418 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4419 | <a name='SkPaint_FontMetrics_hasUnderlineThickness'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4420 | |
| 4421 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4422 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4423 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4424 | 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] | 4425 | </pre> |
| 4426 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 4427 | 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] | 4428 | <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, |
| 4429 | return false, and ignore <a href='#SkPaint_FontMetrics_hasUnderlineThickness_thickness'>thickness</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4430 | |
| 4431 | ### Parameters |
| 4432 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4433 | <table> <tr> <td><a name='SkPaint_FontMetrics_hasUnderlineThickness_thickness'><code><strong>thickness</strong></code></a></td> |
| 4434 | <td>storage for underline width</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4435 | </tr> |
| 4436 | </table> |
| 4437 | |
| 4438 | ### Return Value |
| 4439 | |
| 4440 | true if font specifies underline width |
| 4441 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4442 | <a name='SkPaint_FontMetrics_hasUnderlinePosition'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4443 | |
| 4444 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4445 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4446 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4447 | 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] | 4448 | </pre> |
| 4449 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 4450 | 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] | 4451 | <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, |
| 4452 | return false, and ignore <a href='#SkPaint_FontMetrics_hasUnderlinePosition_position'>position</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4453 | |
| 4454 | ### Parameters |
| 4455 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4456 | <table> <tr> <td><a name='SkPaint_FontMetrics_hasUnderlinePosition_position'><code><strong>position</strong></code></a></td> |
| 4457 | <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] | 4458 | </tr> |
| 4459 | </table> |
| 4460 | |
| 4461 | ### Return Value |
| 4462 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4463 | 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] | 4464 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4465 | <a name='SkPaint_FontMetrics_hasStrikeoutThickness'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4466 | |
| 4467 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4468 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4469 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4470 | 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] | 4471 | </pre> |
| 4472 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 4473 | 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] | 4474 | <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, |
| 4475 | return false, and ignore <a href='#SkPaint_FontMetrics_hasStrikeoutThickness_thickness'>thickness</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4476 | |
| 4477 | ### Parameters |
| 4478 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4479 | <table> <tr> <td><a name='SkPaint_FontMetrics_hasStrikeoutThickness_thickness'><code><strong>thickness</strong></code></a></td> |
| 4480 | <td>storage for strikeout width</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4481 | </tr> |
| 4482 | </table> |
| 4483 | |
| 4484 | ### Return Value |
| 4485 | |
| 4486 | true if font specifies strikeout width |
| 4487 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4488 | <a name='SkPaint_FontMetrics_hasStrikeoutPosition'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4489 | |
| 4490 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4491 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4492 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4493 | 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] | 4494 | </pre> |
| 4495 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 4496 | 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] | 4497 | <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, |
| 4498 | return false, and ignore <a href='#SkPaint_FontMetrics_hasStrikeoutPosition_position'>position</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4499 | |
| 4500 | ### Parameters |
| 4501 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4502 | <table> <tr> <td><a name='SkPaint_FontMetrics_hasStrikeoutPosition_position'><code><strong>position</strong></code></a></td> |
| 4503 | <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] | 4504 | </tr> |
| 4505 | </table> |
| 4506 | |
| 4507 | ### Return Value |
| 4508 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4509 | 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] | 4510 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4511 | <a name='SkPaint_getFontMetrics'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4512 | |
| 4513 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4514 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4515 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4516 | <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] | 4517 | </pre> |
| 4518 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4519 | Returns <a href='#Font_Metrics'>Font Metrics</a> associated with <a href='undocumented#Typeface'>Typeface</a>. |
| 4520 | 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] | 4521 | descent, ascent, and leading. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4522 | 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>. |
| 4523 | Results are scaled by <a href='#Text_Size'>Text Size</a> but does not take into account |
| 4524 | 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>, |
| 4525 | <a href='#Style_Stroke'>Style Stroke</a>, and <a href='undocumented#Path_Effect'>Path Effect</a>. |
| 4526 | 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] | 4527 | is ignored. |
| 4528 | |
| 4529 | ### Parameters |
| 4530 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4531 | <table> <tr> <td><a name='SkPaint_getFontMetrics_metrics'><code><strong>metrics</strong></code></a></td> |
| 4532 | <td>storage for <a href='#Font_Metrics'>Font Metrics</a> from <a href='undocumented#Typeface'>Typeface</a>; may be nullptr</td> |
| 4533 | </tr> |
| 4534 | <tr> <td><a name='SkPaint_getFontMetrics_scale'><code><strong>scale</strong></code></a></td> |
| 4535 | <td>additional multiplier for returned values</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4536 | </tr> |
| 4537 | </table> |
| 4538 | |
| 4539 | ### Return Value |
| 4540 | |
| 4541 | recommended spacing between lines |
| 4542 | |
| 4543 | ### Example |
| 4544 | |
| 4545 | <div><fiddle-embed name="b899d84caba6607340322d317992d070"></fiddle-embed></div> |
| 4546 | |
| 4547 | ### See Also |
| 4548 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4549 | <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] | 4550 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4551 | <a name='SkPaint_getFontSpacing'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4552 | |
| 4553 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4554 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4555 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4556 | <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] | 4557 | </pre> |
| 4558 | |
| 4559 | Returns the recommended spacing between lines: the sum of metrics |
| 4560 | descent, ascent, and leading. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4561 | Result is scaled by <a href='#Text_Size'>Text Size</a> but does not take into account |
| 4562 | dimensions required by stroking and <a href='undocumented#Path_Effect'>Path Effect</a>. |
| 4563 | Returns the same result as <a href='#SkPaint_getFontMetrics'>getFontMetrics</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4564 | |
| 4565 | ### Return Value |
| 4566 | |
| 4567 | recommended spacing between lines |
| 4568 | |
| 4569 | ### Example |
| 4570 | |
| 4571 | <div><fiddle-embed name="424741e26e1b174e43087d67422ce14f"> |
| 4572 | |
| 4573 | #### Example Output |
| 4574 | |
| 4575 | ~~~~ |
| 4576 | textSize: 12 fontSpacing: 13.9688 |
| 4577 | textSize: 18 fontSpacing: 20.9531 |
| 4578 | textSize: 24 fontSpacing: 27.9375 |
| 4579 | textSize: 32 fontSpacing: 37.25 |
| 4580 | ~~~~ |
| 4581 | |
| 4582 | </fiddle-embed></div> |
| 4583 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4584 | <a name='SkPaint_getFontBounds'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4585 | |
| 4586 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4587 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4588 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4589 | <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] | 4590 | </pre> |
| 4591 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4592 | Returns the union of bounds of all <a href='undocumented#Glyph'>Glyphs</a>. |
| 4593 | Returned dimensions are computed by <a href='undocumented#Font_Manager'>Font Manager</a> from font data, |
| 4594 | ignoring <a href='#SkPaint_Hinting'>Hinting</a>. Includes <a href='#Text_Size'>Text Size</a>, <a href='#Text_Scale_X'>Text Scale X</a>, |
| 4595 | 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] | 4596 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4597 | 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, |
| 4598 | returns the same bounds as <a href='#Font_Metrics'>Font Metrics</a> { <a href='#SkPaint_FontMetrics_fXMin'>FontMetrics::fXMin</a>, |
| 4599 | <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] | 4600 | |
| 4601 | ### Return Value |
| 4602 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4603 | union of bounds of all <a href='undocumented#Glyph'>Glyphs</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4604 | |
| 4605 | ### Example |
| 4606 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 4607 | <div><fiddle-embed name="facaddeec7943bc491988e345e27e65f"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4608 | |
| 4609 | #### Example Output |
| 4610 | |
| 4611 | ~~~~ |
| 4612 | metrics bounds = { -12.2461, -14.7891, 21.5215, 5.55469 } |
| 4613 | font bounds = { -12.2461, -14.7891, 21.5215, 5.55469 } |
| 4614 | ~~~~ |
| 4615 | |
| 4616 | </fiddle-embed></div> |
| 4617 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4618 | <a name='SkPaint_textToGlyphs'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4619 | |
| 4620 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4621 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4622 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4623 | 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] | 4624 | </pre> |
| 4625 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4626 | Converts <a href='#SkPaint_textToGlyphs_text'>text</a> into glyph indices. |
| 4627 | Returns the number of glyph indices represented by <a href='#SkPaint_textToGlyphs_text'>text</a>. |
| 4628 | <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>. |
| 4629 | <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] | 4630 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4631 | 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] | 4632 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4633 | If <a href='#SkPaint_textToGlyphs_byteLength'>byteLength</a> equals zero, returns zero. |
| 4634 | 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] | 4635 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4636 | If <a href='#Text_Encoding'>Text Encoding</a> is <a href='#SkPaint_kUTF8_TextEncoding'>kUTF8 TextEncoding</a> and |
| 4637 | <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] | 4638 | |
| 4639 | ### Parameters |
| 4640 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4641 | <table> <tr> <td><a name='SkPaint_textToGlyphs_text'><code><strong>text</strong></code></a></td> |
| 4642 | <td>character storage encoded with <a href='#Text_Encoding'>Text Encoding</a></td> |
| 4643 | </tr> |
| 4644 | <tr> <td><a name='SkPaint_textToGlyphs_byteLength'><code><strong>byteLength</strong></code></a></td> |
| 4645 | <td>length of character storage in bytes</td> |
| 4646 | </tr> |
| 4647 | <tr> <td><a name='SkPaint_textToGlyphs_glyphs'><code><strong>glyphs</strong></code></a></td> |
| 4648 | <td>storage for glyph indices; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4649 | </tr> |
| 4650 | </table> |
| 4651 | |
| 4652 | ### Return Value |
| 4653 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4654 | 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] | 4655 | |
| 4656 | ### Example |
| 4657 | |
| 4658 | <div><fiddle-embed name="343e9471a7f7b5f09abdc3b44983433b"></fiddle-embed></div> |
| 4659 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4660 | <a name='SkPaint_countText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4661 | |
| 4662 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4663 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4664 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4665 | 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] | 4666 | </pre> |
| 4667 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4668 | Returns the number of <a href='undocumented#Glyph'>Glyphs</a> in <a href='#SkPaint_countText_text'>text</a>. |
| 4669 | Uses <a href='#Text_Encoding'>Text Encoding</a> to count the <a href='undocumented#Glyph'>Glyphs</a>. |
| 4670 | Returns the same result as <a href='#SkPaint_textToGlyphs'>textToGlyphs</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4671 | |
| 4672 | ### Parameters |
| 4673 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4674 | <table> <tr> <td><a name='SkPaint_countText_text'><code><strong>text</strong></code></a></td> |
| 4675 | <td>character storage encoded with <a href='#Text_Encoding'>Text Encoding</a></td> |
| 4676 | </tr> |
| 4677 | <tr> <td><a name='SkPaint_countText_byteLength'><code><strong>byteLength</strong></code></a></td> |
| 4678 | <td>length of character storage in bytes</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4679 | </tr> |
| 4680 | </table> |
| 4681 | |
| 4682 | ### Return Value |
| 4683 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4684 | 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] | 4685 | |
| 4686 | ### Example |
| 4687 | |
Cary Clark | f960398 | 2018-07-17 08:20:27 -0400 | [diff] [blame] | 4688 | <div><fiddle-embed name="85436c71aab5410767fc688ab0573e09"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4689 | |
| 4690 | #### Example Output |
| 4691 | |
| 4692 | ~~~~ |
| 4693 | count = 5 |
| 4694 | ~~~~ |
| 4695 | |
| 4696 | </fiddle-embed></div> |
| 4697 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4698 | <a name='SkPaint_containsText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4699 | |
| 4700 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4701 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4702 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4703 | 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] | 4704 | </pre> |
| 4705 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4706 | Returns true if all <a href='#SkPaint_containsText_text'>text</a> corresponds to a non-zero glyph index. |
| 4707 | Returns false if any characters in <a href='#SkPaint_containsText_text'>text</a> are not supported in |
| 4708 | <a href='undocumented#Typeface'>Typeface</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4709 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4710 | If <a href='#Text_Encoding'>Text Encoding</a> is <a href='#SkPaint_kGlyphID_TextEncoding'>kGlyphID TextEncoding</a>, |
| 4711 | returns true if all glyph indices in <a href='#SkPaint_containsText_text'>text</a> are non-zero; |
| 4712 | 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] | 4713 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4714 | Returns true if <a href='#SkPaint_containsText_byteLength'>byteLength</a> is zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4715 | |
| 4716 | ### Parameters |
| 4717 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4718 | <table> <tr> <td><a name='SkPaint_containsText_text'><code><strong>text</strong></code></a></td> |
| 4719 | <td>array of characters or <a href='undocumented#Glyph'>Glyphs</a></td> |
| 4720 | </tr> |
| 4721 | <tr> <td><a name='SkPaint_containsText_byteLength'><code><strong>byteLength</strong></code></a></td> |
| 4722 | <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] | 4723 | </tr> |
| 4724 | </table> |
| 4725 | |
| 4726 | ### Return Value |
| 4727 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4728 | 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] | 4729 | |
Ruiqi Mao | 94d57c4 | 2018-07-02 15:20:10 -0400 | [diff] [blame] | 4730 | <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] | 4731 | corresponding to the Unicode surrogate code point. |
| 4732 | </div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4733 | |
| 4734 | #### Example Output |
| 4735 | |
| 4736 | ~~~~ |
| 4737 | 0x00b0 == has char |
| 4738 | 0xd800 != has char |
| 4739 | ~~~~ |
| 4740 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4741 | ### Example |
| 4742 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 4743 | <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] | 4744 | 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] | 4745 | </div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4746 | |
| 4747 | #### Example Output |
| 4748 | |
| 4749 | ~~~~ |
| 4750 | 0x01ff == has glyph |
| 4751 | 0x0000 != has glyph |
| 4752 | 0xffff == has glyph |
| 4753 | ~~~~ |
| 4754 | |
| 4755 | </fiddle-embed></div> |
| 4756 | |
| 4757 | ### See Also |
| 4758 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4759 | <a href='#SkPaint_setTextEncoding'>setTextEncoding</a> <a href='undocumented#Typeface'>Typeface</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4760 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4761 | <a name='SkPaint_glyphsToUnichars'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4762 | |
| 4763 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4764 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4765 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4766 | 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] | 4767 | </pre> |
| 4768 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4769 | Converts <a href='#SkPaint_glyphsToUnichars_glyphs'>glyphs</a> into <a href='#SkPaint_glyphsToUnichars_text'>text</a> if possible. |
| 4770 | <a href='undocumented#Glyph'>Glyph</a> values without direct Unicode equivalents are mapped to zero. |
| 4771 | Uses the <a href='undocumented#Typeface'>Typeface</a>, but is unaffected |
| 4772 | 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] | 4773 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4774 | 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] | 4775 | |
| 4776 | ### Parameters |
| 4777 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4778 | <table> <tr> <td><a name='SkPaint_glyphsToUnichars_glyphs'><code><strong>glyphs</strong></code></a></td> |
| 4779 | <td>array of indices into font</td> |
| 4780 | </tr> |
| 4781 | <tr> <td><a name='SkPaint_glyphsToUnichars_count'><code><strong>count</strong></code></a></td> |
| 4782 | <td>length of glyph array</td> |
| 4783 | </tr> |
| 4784 | <tr> <td><a name='SkPaint_glyphsToUnichars_text'><code><strong>text</strong></code></a></td> |
| 4785 | <td>storage for character codes, one per glyph</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4786 | </tr> |
| 4787 | </table> |
| 4788 | |
| 4789 | ### Example |
| 4790 | |
skia-bookmaker | b95bbba | 2018-07-06 05:23:23 +0000 | [diff] [blame] | 4791 | <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] | 4792 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4793 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4794 | <a name='Measure_Text'></a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4795 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4796 | <a name='SkPaint_measureText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4797 | |
| 4798 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4799 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4800 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4801 | <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] | 4802 | </pre> |
| 4803 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4804 | Returns the advance width of <a href='#SkPaint_measureText_text'>text</a> if <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> is clear, |
| 4805 | and the height of <a href='#SkPaint_measureText_text'>text</a> if <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> is set. |
| 4806 | The advance is the normal distance to move before drawing additional <a href='#SkPaint_measureText_text'>text</a>. |
| 4807 | 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, |
| 4808 | 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 |
| 4809 | <a href='undocumented#Path_Effect'>Path Effect</a> to scale the metrics and <a href='#SkPaint_measureText_bounds'>bounds</a>. |
| 4810 | Returns the bounding box of <a href='#SkPaint_measureText_text'>text</a> if <a href='#SkPaint_measureText_bounds'>bounds</a> is not nullptr. |
| 4811 | 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] | 4812 | |
| 4813 | ### Parameters |
| 4814 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4815 | <table> <tr> <td><a name='SkPaint_measureText_text'><code><strong>text</strong></code></a></td> |
| 4816 | <td>character codes or glyph indices to be measured</td> |
| 4817 | </tr> |
| 4818 | <tr> <td><a name='SkPaint_measureText_length'><code><strong>length</strong></code></a></td> |
| 4819 | <td>number of bytes of <a href='#SkPaint_measureText_text'>text</a> to measure</td> |
| 4820 | </tr> |
| 4821 | <tr> <td><a name='SkPaint_measureText_bounds'><code><strong>bounds</strong></code></a></td> |
| 4822 | <td>returns bounding box relative to (0, 0) if not nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4823 | </tr> |
| 4824 | </table> |
| 4825 | |
| 4826 | ### Return Value |
| 4827 | |
| 4828 | advance width or height |
| 4829 | |
| 4830 | ### Example |
| 4831 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 4832 | <div><fiddle-embed name="06084f609184470135a9cd9ebc5af149"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4833 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4834 | <a name='SkPaint_measureText_2'></a> |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 4835 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4836 | --- |
| 4837 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4838 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4839 | <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] | 4840 | </pre> |
| 4841 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4842 | Returns the advance width of <a href='#SkPaint_measureText_2_text'>text</a> if <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> is clear, |
| 4843 | and the height of <a href='#SkPaint_measureText_2_text'>text</a> if <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> is set. |
| 4844 | The advance is the normal distance to move before drawing additional <a href='#SkPaint_measureText_2_text'>text</a>. |
| 4845 | 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, |
| 4846 | and <a href='#Text_Size'>Text Size</a> to scale the metrics. |
| 4847 | 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] | 4848 | |
| 4849 | ### Parameters |
| 4850 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4851 | <table> <tr> <td><a name='SkPaint_measureText_2_text'><code><strong>text</strong></code></a></td> |
| 4852 | <td>character codes or glyph indices to be measured</td> |
| 4853 | </tr> |
| 4854 | <tr> <td><a name='SkPaint_measureText_2_length'><code><strong>length</strong></code></a></td> |
| 4855 | <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] | 4856 | </tr> |
| 4857 | </table> |
| 4858 | |
| 4859 | ### Return Value |
| 4860 | |
| 4861 | advance width or height |
| 4862 | |
| 4863 | ### Example |
| 4864 | |
| 4865 | <div><fiddle-embed name="f1139a5ddd17fd47c2f45f6e642cac76"> |
| 4866 | |
| 4867 | #### Example Output |
| 4868 | |
| 4869 | ~~~~ |
| 4870 | default width = 5 |
| 4871 | double width = 10 |
| 4872 | ~~~~ |
| 4873 | |
| 4874 | </fiddle-embed></div> |
| 4875 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4876 | <a name='SkPaint_breakText'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4877 | |
| 4878 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4879 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4880 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4881 | size_t <a href='#SkPaint_breakText'>breakText</a>(const void* text, size_t length, <a href='undocumented#SkScalar'>SkScalar</a> maxWidth, |
| 4882 | <a href='undocumented#SkScalar'>SkScalar</a>* measuredWidth = nullptr) const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4883 | </pre> |
| 4884 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4885 | Returns the bytes of <a href='#SkPaint_breakText_text'>text</a> that fit within <a href='#SkPaint_breakText_maxWidth'>maxWidth</a>. |
| 4886 | If <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> is clear, the <a href='#SkPaint_breakText_text'>text</a> fragment fits if its advance width is less than or |
| 4887 | equal to <a href='#SkPaint_breakText_maxWidth'>maxWidth</a>. |
| 4888 | If <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> is set, the <a href='#SkPaint_breakText_text'>text</a> fragment fits if its advance height is less than or |
| 4889 | equal to <a href='#SkPaint_breakText_maxWidth'>maxWidth</a>. |
| 4890 | Measures only while the advance is less than or equal to <a href='#SkPaint_breakText_maxWidth'>maxWidth</a>. |
| 4891 | 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. |
| 4892 | 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, |
| 4893 | and <a href='#Text_Size'>Text Size</a> to scale the metrics. |
| 4894 | 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] | 4895 | |
| 4896 | ### Parameters |
| 4897 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4898 | <table> <tr> <td><a name='SkPaint_breakText_text'><code><strong>text</strong></code></a></td> |
| 4899 | <td>character codes or glyph indices to be measured</td> |
| 4900 | </tr> |
| 4901 | <tr> <td><a name='SkPaint_breakText_length'><code><strong>length</strong></code></a></td> |
| 4902 | <td>number of bytes of <a href='#SkPaint_breakText_text'>text</a> to measure</td> |
| 4903 | </tr> |
| 4904 | <tr> <td><a name='SkPaint_breakText_maxWidth'><code><strong>maxWidth</strong></code></a></td> |
| 4905 | <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> |
| 4906 | </tr> |
| 4907 | <tr> <td><a name='SkPaint_breakText_measuredWidth'><code><strong>measuredWidth</strong></code></a></td> |
| 4908 | <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] | 4909 | </tr> |
| 4910 | </table> |
| 4911 | |
| 4912 | ### Return Value |
| 4913 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4914 | 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] | 4915 | |
| 4916 | ### Example |
| 4917 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4918 | <div><fiddle-embed name="fd0033470ccbd5c7059670fdbf96cffc"><div><a href='undocumented#Line'>Line</a> under "" shows desired width, shorter than available characters. |
| 4919 | <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] | 4920 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4921 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4922 | <a name='SkPaint_getTextWidths'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4923 | |
| 4924 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4925 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4926 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4927 | 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] | 4928 | </pre> |
| 4929 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4930 | Retrieves the advance and <a href='#SkPaint_getTextWidths_bounds'>bounds</a> for each glyph in <a href='#SkPaint_getTextWidths_text'>text</a>, and returns |
| 4931 | the glyph count in <a href='#SkPaint_getTextWidths_text'>text</a>. |
| 4932 | Both <a href='#SkPaint_getTextWidths_widths'>widths</a> and <a href='#SkPaint_getTextWidths_bounds'>bounds</a> may be nullptr. |
| 4933 | 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. |
| 4934 | 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. |
| 4935 | If <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> is clear, <a href='#SkPaint_getTextWidths_widths'>widths</a> returns the horizontal advance. |
| 4936 | If <a href='#SkPaint_kVerticalText_Flag'>kVerticalText Flag</a> is set, <a href='#SkPaint_getTextWidths_widths'>widths</a> returns the vertical advance. |
| 4937 | 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, |
| 4938 | 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>. |
| 4939 | Does not scale the advance by <a href='#Fake_Bold'>Fake Bold</a> or <a href='undocumented#Path_Effect'>Path Effect</a>. |
| 4940 | 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] | 4941 | |
| 4942 | ### Parameters |
| 4943 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4944 | <table> <tr> <td><a name='SkPaint_getTextWidths_text'><code><strong>text</strong></code></a></td> |
| 4945 | <td>character codes or glyph indices to be measured</td> |
| 4946 | </tr> |
| 4947 | <tr> <td><a name='SkPaint_getTextWidths_byteLength'><code><strong>byteLength</strong></code></a></td> |
| 4948 | <td>number of bytes of <a href='#SkPaint_getTextWidths_text'>text</a> to measure</td> |
| 4949 | </tr> |
| 4950 | <tr> <td><a name='SkPaint_getTextWidths_widths'><code><strong>widths</strong></code></a></td> |
| 4951 | <td>returns <a href='#SkPaint_getTextWidths_text'>text</a> advances for each glyph; may be nullptr</td> |
| 4952 | </tr> |
| 4953 | <tr> <td><a name='SkPaint_getTextWidths_bounds'><code><strong>bounds</strong></code></a></td> |
| 4954 | <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] | 4955 | </tr> |
| 4956 | </table> |
| 4957 | |
| 4958 | ### Return Value |
| 4959 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4960 | glyph count in <a href='#SkPaint_getTextWidths_text'>text</a> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4961 | |
| 4962 | ### Example |
| 4963 | |
Cary Clark | f960398 | 2018-07-17 08:20:27 -0400 | [diff] [blame] | 4964 | <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] | 4965 | 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] | 4966 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4967 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4968 | <a name='Text_Path'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 4969 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4970 | <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] | 4971 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4972 | <a name='SkPaint_getTextPath'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 4973 | |
| 4974 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 4975 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4976 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 4977 | 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] | 4978 | </pre> |
| 4979 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4980 | Returns the geometry as <a href='SkPath_Reference#Path'>Path</a> equivalent to the drawn <a href='#SkPaint_getTextPath_text'>text</a>. |
| 4981 | 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, |
| 4982 | 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. |
| 4983 | All of the glyph paths are stored in <a href='#SkPaint_getTextPath_path'>path</a>. |
| 4984 | 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] | 4985 | |
| 4986 | ### Parameters |
| 4987 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 4988 | <table> <tr> <td><a name='SkPaint_getTextPath_text'><code><strong>text</strong></code></a></td> |
| 4989 | <td>character codes or glyph indices</td> |
| 4990 | </tr> |
| 4991 | <tr> <td><a name='SkPaint_getTextPath_length'><code><strong>length</strong></code></a></td> |
| 4992 | <td>number of bytes of <a href='#SkPaint_getTextPath_text'>text</a></td> |
| 4993 | </tr> |
| 4994 | <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] | 4995 | <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] | 4996 | </tr> |
| 4997 | <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] | 4998 | <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] | 4999 | </tr> |
| 5000 | <tr> <td><a name='SkPaint_getTextPath_path'><code><strong>path</strong></code></a></td> |
| 5001 | <td>geometry of the <a href='undocumented#Glyph'>Glyphs</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5002 | </tr> |
| 5003 | </table> |
| 5004 | |
| 5005 | ### Example |
| 5006 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5007 | <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] | 5008 | the offset location. The result is rendered with one draw call. |
| 5009 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5010 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5011 | <a name='SkPaint_getPosTextPath'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 5012 | |
| 5013 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5014 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5015 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 5016 | 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] | 5017 | </pre> |
| 5018 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5019 | Returns the geometry as <a href='SkPath_Reference#Path'>Path</a> equivalent to the drawn <a href='#SkPaint_getPosTextPath_text'>text</a>. |
| 5020 | 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, |
| 5021 | 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. |
| 5022 | All of the glyph paths are stored in <a href='#SkPaint_getPosTextPath_path'>path</a>. |
| 5023 | 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>. |
| 5024 | <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] | 5025 | |
| 5026 | ### Parameters |
| 5027 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5028 | <table> <tr> <td><a name='SkPaint_getPosTextPath_text'><code><strong>text</strong></code></a></td> |
| 5029 | <td>character codes or glyph indices</td> |
| 5030 | </tr> |
| 5031 | <tr> <td><a name='SkPaint_getPosTextPath_length'><code><strong>length</strong></code></a></td> |
| 5032 | <td>number of bytes of <a href='#SkPaint_getPosTextPath_text'>text</a></td> |
| 5033 | </tr> |
| 5034 | <tr> <td><a name='SkPaint_getPosTextPath_pos'><code><strong>pos</strong></code></a></td> |
| 5035 | <td>positions of each glyph</td> |
| 5036 | </tr> |
| 5037 | <tr> <td><a name='SkPaint_getPosTextPath_path'><code><strong>path</strong></code></a></td> |
| 5038 | <td>geometry of the <a href='undocumented#Glyph'>Glyphs</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5039 | </tr> |
| 5040 | </table> |
| 5041 | |
| 5042 | ### Example |
| 5043 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5044 | <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] | 5045 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5046 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 5047 | <a name='Text_Intercepts'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 5048 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5049 | <a href='#Text_Intercepts'>Text Intercepts</a> describe the intersection of drawn text <a href='undocumented#Glyph'>Glyphs</a> with a pair |
| 5050 | 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] | 5051 | underline that skips <a href='undocumented#Descenders'>Descenders</a>. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5052 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5053 | <a name='SkPaint_getTextIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 5054 | |
| 5055 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5056 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5057 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 5058 | 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, |
| 5059 | 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] | 5060 | </pre> |
| 5061 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5062 | Returns the number of <a href='#SkPaint_getTextIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getTextIntercepts_bounds'>bounds</a>. |
| 5063 | <a href='#SkPaint_getTextIntercepts_bounds'>bounds</a> describes a pair of lines parallel to the <a href='#SkPaint_getTextIntercepts_text'>text</a> advance. |
| 5064 | 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] | 5065 | the string. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5066 | 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, |
| 5067 | 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. |
| 5068 | 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] | 5069 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5070 | 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] | 5071 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5072 | <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] | 5073 | |
| 5074 | ### Parameters |
| 5075 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5076 | <table> <tr> <td><a name='SkPaint_getTextIntercepts_text'><code><strong>text</strong></code></a></td> |
| 5077 | <td>character codes or glyph indices</td> |
| 5078 | </tr> |
| 5079 | <tr> <td><a name='SkPaint_getTextIntercepts_length'><code><strong>length</strong></code></a></td> |
| 5080 | <td>number of bytes of <a href='#SkPaint_getTextIntercepts_text'>text</a></td> |
| 5081 | </tr> |
| 5082 | <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] | 5083 | <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] | 5084 | </tr> |
| 5085 | <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] | 5086 | <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] | 5087 | </tr> |
| 5088 | <tr> <td><a name='SkPaint_getTextIntercepts_bounds'><code><strong>bounds</strong></code></a></td> |
| 5089 | <td>lower and upper line parallel to the advance</td> |
| 5090 | </tr> |
| 5091 | <tr> <td><a name='SkPaint_getTextIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 5092 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5093 | </tr> |
| 5094 | </table> |
| 5095 | |
| 5096 | ### Return Value |
| 5097 | |
| 5098 | number of intersections; may be zero |
| 5099 | |
| 5100 | ### Example |
| 5101 | |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 5102 | <div><fiddle-embed name="2a0b80ed20d193c688085b79deb5bdc9"><div>Underline uses intercepts to draw on either side of the glyph Descender. |
| 5103 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5104 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5105 | <a name='SkPaint_getPosTextIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 5106 | |
| 5107 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5108 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5109 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 5110 | int <a href='#SkPaint_getPosTextIntercepts'>getPosTextIntercepts</a>(const void* text, size_t length, const <a href='SkPoint_Reference#SkPoint'>SkPoint</a> pos[], |
| 5111 | 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] | 5112 | </pre> |
| 5113 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5114 | Returns the number of <a href='#SkPaint_getPosTextIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getPosTextIntercepts_bounds'>bounds</a>. |
| 5115 | <a href='#SkPaint_getPosTextIntercepts_bounds'>bounds</a> describes a pair of lines parallel to the <a href='#SkPaint_getPosTextIntercepts_text'>text</a> advance. |
| 5116 | 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] | 5117 | the string. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5118 | 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, |
| 5119 | 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. |
| 5120 | 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] | 5121 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5122 | 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] | 5123 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5124 | <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] | 5125 | |
| 5126 | ### Parameters |
| 5127 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5128 | <table> <tr> <td><a name='SkPaint_getPosTextIntercepts_text'><code><strong>text</strong></code></a></td> |
| 5129 | <td>character codes or glyph indices</td> |
| 5130 | </tr> |
| 5131 | <tr> <td><a name='SkPaint_getPosTextIntercepts_length'><code><strong>length</strong></code></a></td> |
| 5132 | <td>number of bytes of <a href='#SkPaint_getPosTextIntercepts_text'>text</a></td> |
| 5133 | </tr> |
| 5134 | <tr> <td><a name='SkPaint_getPosTextIntercepts_pos'><code><strong>pos</strong></code></a></td> |
| 5135 | <td>positions of each glyph</td> |
| 5136 | </tr> |
| 5137 | <tr> <td><a name='SkPaint_getPosTextIntercepts_bounds'><code><strong>bounds</strong></code></a></td> |
| 5138 | <td>lower and upper line parallel to the advance</td> |
| 5139 | </tr> |
| 5140 | <tr> <td><a name='SkPaint_getPosTextIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 5141 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5142 | </tr> |
| 5143 | </table> |
| 5144 | |
| 5145 | ### Return Value |
| 5146 | |
Cary Clark | a523d2d | 2017-08-30 08:58:10 -0400 | [diff] [blame] | 5147 | number of intersections; may be zero |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5148 | |
| 5149 | ### Example |
| 5150 | |
skia-bookmaker | 61cc9fa | 2018-07-11 05:28:17 +0000 | [diff] [blame] | 5151 | <div><fiddle-embed name="98b2dfc552d0540a7c041fe7a2839bd7"><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] | 5152 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5153 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5154 | <a name='SkPaint_getPosTextHIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 5155 | |
| 5156 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5157 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5158 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 5159 | 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, |
| 5160 | 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] | 5161 | </pre> |
| 5162 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5163 | Returns the number of <a href='#SkPaint_getPosTextHIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getPosTextHIntercepts_bounds'>bounds</a>. |
| 5164 | <a href='#SkPaint_getPosTextHIntercepts_bounds'>bounds</a> describes a pair of lines parallel to the <a href='#SkPaint_getPosTextHIntercepts_text'>text</a> advance. |
| 5165 | 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] | 5166 | the string. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5167 | 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, |
| 5168 | 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. |
| 5169 | 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] | 5170 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5171 | 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] | 5172 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5173 | <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] | 5174 | |
| 5175 | ### Parameters |
| 5176 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5177 | <table> <tr> <td><a name='SkPaint_getPosTextHIntercepts_text'><code><strong>text</strong></code></a></td> |
| 5178 | <td>character codes or glyph indices</td> |
| 5179 | </tr> |
| 5180 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_length'><code><strong>length</strong></code></a></td> |
| 5181 | <td>number of bytes of <a href='#SkPaint_getPosTextHIntercepts_text'>text</a></td> |
| 5182 | </tr> |
| 5183 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_xpos'><code><strong>xpos</strong></code></a></td> |
| 5184 | <td>positions of each glyph in x</td> |
| 5185 | </tr> |
| 5186 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_constY'><code><strong>constY</strong></code></a></td> |
| 5187 | <td>position of each glyph in y</td> |
| 5188 | </tr> |
| 5189 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_bounds'><code><strong>bounds</strong></code></a></td> |
| 5190 | <td>lower and upper line parallel to the advance</td> |
| 5191 | </tr> |
| 5192 | <tr> <td><a name='SkPaint_getPosTextHIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 5193 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5194 | </tr> |
| 5195 | </table> |
| 5196 | |
| 5197 | ### Return Value |
| 5198 | |
| 5199 | number of intersections; may be zero |
| 5200 | |
| 5201 | ### Example |
| 5202 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 5203 | <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] | 5204 | </div></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5205 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5206 | <a name='SkPaint_getTextBlobIntercepts'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 5207 | |
| 5208 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5209 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5210 | <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] | 5211 | 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] | 5212 | </pre> |
| 5213 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5214 | Returns the number of <a href='#SkPaint_getTextBlobIntercepts_intervals'>intervals</a> that intersect <a href='#SkPaint_getTextBlobIntercepts_bounds'>bounds</a>. |
| 5215 | <a href='#SkPaint_getTextBlobIntercepts_bounds'>bounds</a> describes a pair of lines parallel to the text advance. |
| 5216 | 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] | 5217 | the string. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5218 | Uses <a href='undocumented#Typeface'>Typeface</a> to get the glyph paths, |
| 5219 | 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. |
| 5220 | 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] | 5221 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5222 | <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] | 5223 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5224 | 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] | 5225 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5226 | <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] | 5227 | |
| 5228 | ### Parameters |
| 5229 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5230 | <table> <tr> <td><a name='SkPaint_getTextBlobIntercepts_blob'><code><strong>blob</strong></code></a></td> |
| 5231 | <td><a href='undocumented#Glyph'>Glyphs</a>, positions, and text paint attributes</td> |
| 5232 | </tr> |
| 5233 | <tr> <td><a name='SkPaint_getTextBlobIntercepts_bounds'><code><strong>bounds</strong></code></a></td> |
| 5234 | <td>lower and upper line parallel to the advance</td> |
| 5235 | </tr> |
| 5236 | <tr> <td><a name='SkPaint_getTextBlobIntercepts_intervals'><code><strong>intervals</strong></code></a></td> |
| 5237 | <td>returned intersections; may be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5238 | </tr> |
| 5239 | </table> |
| 5240 | |
| 5241 | ### Return Value |
| 5242 | |
| 5243 | number of intersections; may be zero |
| 5244 | |
| 5245 | ### Example |
| 5246 | |
skia-bookmaker | 44bad2e | 2018-07-05 05:35:27 +0000 | [diff] [blame] | 5247 | <div><fiddle-embed name="f2229dd5c8e76f9e12fafe59b61353c8"></fiddle-embed></div> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5248 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5249 | <a name='SkPaint_nothingToDraw'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 5250 | |
| 5251 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5252 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5253 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 5254 | bool <a href='#SkPaint_nothingToDraw'>nothingToDraw</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5255 | </pre> |
| 5256 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5257 | Returns true if <a href='#Paint'>Paint</a> prevents all drawing; |
| 5258 | 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] | 5259 | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 5260 | 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] | 5261 | new <a href='SkColor_Reference#Alpha'>Alpha</a> of zero. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5262 | |
| 5263 | ### Return Value |
| 5264 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5265 | true if <a href='#Paint'>Paint</a> prevents all drawing |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5266 | |
| 5267 | ### Example |
| 5268 | |
Cary Clark | 8364706 | 2018-07-18 16:21:51 -0400 | [diff] [blame] | 5269 | <div><fiddle-embed name="2973b05bfbb6b4c29332c8ac4fcf3995"> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5270 | |
| 5271 | #### Example Output |
| 5272 | |
| 5273 | ~~~~ |
| 5274 | initial nothing to draw: false |
| 5275 | blend dst nothing to draw: true |
| 5276 | blend src over nothing to draw: false |
| 5277 | alpha 0 nothing to draw: true |
| 5278 | ~~~~ |
| 5279 | |
| 5280 | </fiddle-embed></div> |
| 5281 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 5282 | <a name='Fast_Bounds'></a> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 5283 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 5284 | Private: To be made private. |
| 5285 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5286 | <a href='#Fast_Bounds'>Fast Bounds</a> functions conservatively outset a drawing bounds by additional area |
| 5287 | <a href='#Paint'>Paint</a> may draw to. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5288 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5289 | <a name='SkPaint_canComputeFastBounds'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 5290 | |
| 5291 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5292 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5293 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 5294 | bool <a href='#SkPaint_canComputeFastBounds'>canComputeFastBounds</a>() const |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5295 | </pre> |
| 5296 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 5297 | Private: (to be made private) |
| 5298 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5299 | Returns true if <a href='#Paint'>Paint</a> does not include elements requiring extensive computation |
| 5300 | 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] | 5301 | always returns false. |
| 5302 | |
| 5303 | ### Return Value |
| 5304 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5305 | 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] | 5306 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5307 | <a name='SkPaint_computeFastBounds'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 5308 | |
| 5309 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5310 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5311 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 5312 | 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] | 5313 | </pre> |
| 5314 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 5315 | Private: (to be made private) |
| 5316 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5317 | 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] | 5318 | 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] | 5319 | 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] | 5320 | parameter. It returns the adjusted bounds that can then be used |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5321 | for <a href='SkCanvas_Reference#SkCanvas_quickReject'>SkCanvas::quickReject</a> tests. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5322 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5323 | 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 |
| 5324 | should not rely on <a href='#SkPaint_computeFastBounds_storage'>storage</a> being set to the result, but should always |
| 5325 | 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 |
| 5326 | <a href='SkRect_Reference#Rect'>Rect</a>. |
| 5327 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 5328 | Private: For example: |
| 5329 | if (!path.isInverseFillType() && paint.canComputeFastBounds()) { |
| 5330 | SkRect storage; |
| 5331 | if (canvas->quickReject(paint.computeFastBounds(path.getBounds(), &storage))) { |
| 5332 | return; // do not draw the path |
| 5333 | } |
| 5334 | } |
| 5335 | // draw the path |
| 5336 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5337 | ### Parameters |
| 5338 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5339 | <table> <tr> <td><a name='SkPaint_computeFastBounds_orig'><code><strong>orig</strong></code></a></td> |
| 5340 | <td>geometry modified by <a href='#Paint'>Paint</a> when drawn</td> |
| 5341 | </tr> |
| 5342 | <tr> <td><a name='SkPaint_computeFastBounds_storage'><code><strong>storage</strong></code></a></td> |
| 5343 | <td>computed bounds of geometry; may not be nullptr</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5344 | </tr> |
| 5345 | </table> |
| 5346 | |
| 5347 | ### Return Value |
| 5348 | |
| 5349 | fast computed bounds |
| 5350 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5351 | <a name='SkPaint_computeFastStrokeBounds'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 5352 | |
| 5353 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5354 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5355 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 5356 | 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] | 5357 | </pre> |
| 5358 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 5359 | Private: (to be made private) |
| 5360 | |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5361 | ### Parameters |
| 5362 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5363 | <table> <tr> <td><a name='SkPaint_computeFastStrokeBounds_orig'><code><strong>orig</strong></code></a></td> |
| 5364 | <td>geometry modified by <a href='#Paint'>Paint</a> when drawn</td> |
| 5365 | </tr> |
| 5366 | <tr> <td><a name='SkPaint_computeFastStrokeBounds_storage'><code><strong>storage</strong></code></a></td> |
| 5367 | <td>computed bounds of geometry</td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5368 | </tr> |
| 5369 | </table> |
| 5370 | |
| 5371 | ### Return Value |
| 5372 | |
| 5373 | fast computed bounds |
| 5374 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5375 | <a name='SkPaint_doComputeFastBounds'></a> |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 5376 | |
| 5377 | --- |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5378 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5379 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 5380 | 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] | 5381 | </pre> |
| 5382 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 5383 | Private: (to be made private) |
| 5384 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5385 | Computes the bounds, overriding the <a href='#Paint'>Paint</a> <a href='#SkPaint_Style'>Style</a>. This can be used to |
| 5386 | account for additional width required by stroking <a href='#SkPaint_doComputeFastBounds_orig'>orig</a>, without |
| 5387 | altering <a href='#SkPaint_Style'>Style</a> set to fill. |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5388 | |
| 5389 | ### Parameters |
| 5390 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 5391 | <table> <tr> <td><a name='SkPaint_doComputeFastBounds_orig'><code><strong>orig</strong></code></a></td> |
| 5392 | <td>geometry modified by <a href='#Paint'>Paint</a> when drawn</td> |
| 5393 | </tr> |
| 5394 | <tr> <td><a name='SkPaint_doComputeFastBounds_storage'><code><strong>storage</strong></code></a></td> |
| 5395 | <td>computed bounds of geometry</td> |
| 5396 | </tr> |
| 5397 | <tr> <td><a name='SkPaint_doComputeFastBounds_style'><code><strong>style</strong></code></a></td> |
| 5398 | <td>overrides <a href='#SkPaint_Style'>Style</a></td> |
Cary Clark | 12799e1 | 2017-07-28 15:18:29 -0400 | [diff] [blame] | 5399 | </tr> |
| 5400 | </table> |
| 5401 | |
| 5402 | ### Return Value |
| 5403 | |
| 5404 | fast computed bounds |
| 5405 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame^] | 5406 | <a name='Utility'></a> |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 5407 | |