Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1 | SkIPoint Reference |
| 2 | === |
| 3 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 4 | # <a name='IPoint'>IPoint</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 5 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 6 | # <a name='SkIPoint'>Struct SkIPoint</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 7 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 8 | ## <a name='Typedef'>Typedef</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 9 | |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 10 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 11 | SkIPoint <code>typedef</code> define a data type. |
| 12 | <table style='border-collapse: collapse; width: 62.5em'> |
| 13 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Topic</th> |
| 14 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 15 | </table> |
| 16 | <a href='#SkIPoint'>SkIPoint</a> holds two 32-bit integer coordinates. |
Cary Clark | 5081eed | 2018-01-22 07:55:48 -0500 | [diff] [blame] | 17 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 18 | ## Overview |
Cary Clark | 5081eed | 2018-01-22 07:55:48 -0500 | [diff] [blame] | 19 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 20 | <table style='border-collapse: collapse; width: 62.5em'> |
| 21 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Topic</th> |
| 22 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 23 | <tr style='background-color: #f0f0f0; '> |
| 24 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#Constructor'>Constructors</a></td> |
| 25 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>functions that construct <a href='#SkIPoint'>SkIPoint</a></td> |
| 26 | </tr> |
| 27 | <tr> |
| 28 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#Member_Function'>Functions</a></td> |
| 29 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>global and class member functions</td> |
| 30 | </tr> |
| 31 | <tr style='background-color: #f0f0f0; '> |
| 32 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#Member'>Members</a></td> |
| 33 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>member values</td> |
| 34 | </tr> |
| 35 | <tr> |
| 36 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#Operator'>Operators</a></td> |
| 37 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>operator overloading methods</td> |
| 38 | </tr> |
| 39 | <tr style='background-color: #f0f0f0; '> |
| 40 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#Related_Function'>Related Functions</a></td> |
| 41 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>similar member functions grouped together</td> |
| 42 | </tr> |
| 43 | </table> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 44 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 45 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 46 | ## <a name='Related_Function'>Related Function</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 47 | |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 48 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 49 | SkIPoint global, <code>struct</code>, and <code>class</code> related member functions share a topic. |
| 50 | <table style='border-collapse: collapse; width: 62.5em'> |
| 51 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Topic</th> |
| 52 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 53 | <tr style='background-color: #f0f0f0; '> |
| 54 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#IVector'>IVector</a></td> |
| 55 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>alias for <a href='#IPoint'>IPoint</a></td> |
| 56 | </tr> |
| 57 | <tr> |
| 58 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#Property'>Property</a></td> |
| 59 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>member values</td> |
| 60 | </tr> |
| 61 | <tr style='background-color: #f0f0f0; '> |
| 62 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#Set'>Set</a></td> |
| 63 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>replaces all values</td> |
| 64 | </tr> |
| 65 | </table> |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 66 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 67 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 68 | ## <a name='Member_Function'>Member Function</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 69 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 70 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 71 | SkIPoint member functions read and modify the structure properties. |
| 72 | <table style='border-collapse: collapse; width: 62.5em'> |
| 73 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Topic</th> |
| 74 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 75 | <tr style='background-color: #f0f0f0; '> |
| 76 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_Make'>Make</a></td> |
| 77 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>constructs from integer inputs</td> |
| 78 | </tr> |
| 79 | <tr> |
| 80 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_equals'>equals</a></td> |
| 81 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>returns true if members are equal</td> |
| 82 | </tr> |
| 83 | <tr style='background-color: #f0f0f0; '> |
| 84 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_isZero'>isZero</a></td> |
| 85 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>returns true if both members equal zero</td> |
| 86 | </tr> |
| 87 | <tr> |
| 88 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_set'>set</a></td> |
| 89 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>sets to integer input</td> |
| 90 | </tr> |
| 91 | <tr style='background-color: #f0f0f0; '> |
| 92 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_x'>x</a></td> |
| 93 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>returns <a href='#SkIPoint_fX'>fX</a></td> |
| 94 | </tr> |
| 95 | <tr> |
| 96 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_y'>y</a></td> |
| 97 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>returns <a href='#SkIPoint_fY'>fY</a></td> |
| 98 | </tr> |
| 99 | </table> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 100 | |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 101 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 102 | ## <a name='Member'>Member</a> |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 103 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 104 | |
| 105 | |
| 106 | ### Members |
| 107 | |
| 108 | <table style='border-collapse: collapse; width: 62.5em'> |
| 109 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Type</th> |
| 110 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Name</th> |
| 111 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 112 | <tr style='background-color: #f0f0f0; '> |
| 113 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>int32_t</td> |
| 114 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#fX'><code>fX</code></a></td> |
| 115 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>x-axis value</td> |
| 116 | </tr> |
| 117 | <tr> |
| 118 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>int32_t</td> |
| 119 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#fY'><code>fY</code></a></td> |
| 120 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>y-axis value</td> |
| 121 | </tr> |
| 122 | </table> |
| 123 | |
| 124 | |
| 125 | SkIPoint members may be read and written directly without using a member function. |
| 126 | <table style='border-collapse: collapse; width: 62.5em'> |
| 127 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Topic</th> |
| 128 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 129 | <tr style='background-color: #f0f0f0; '> |
| 130 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_fX'>fX</a></td> |
| 131 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>x-axis value</td> |
| 132 | </tr> |
| 133 | <tr> |
| 134 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_fY'>fY</a></td> |
| 135 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>y-axis value</td> |
| 136 | </tr> |
| 137 | </table> |
| 138 | |
| 139 | |
| 140 | ### Members |
| 141 | |
| 142 | <table style='border-collapse: collapse; width: 62.5em'> |
| 143 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Type</th> |
| 144 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Name</th> |
| 145 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 146 | <tr style='background-color: #f0f0f0; '> |
| 147 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>int32_t</td> |
| 148 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkIPoint_fX'><code>fX</code></a></td> |
| 149 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 150 | x-axis value used by <a href='#IPoint'>IPoint</a>. |
| 151 | </td> |
| 152 | </tr> |
| 153 | <tr> |
| 154 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>int32_t</td> |
| 155 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a name='SkIPoint_fY'><code>fY</code></a></td> |
| 156 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '> |
| 157 | y-axis value used by <a href='#IPoint'>IPoint</a>. |
| 158 | </td> |
| 159 | </tr> |
| 160 | |
| 161 | |
| 162 | ## <a name='Constructor'>Constructor</a> |
| 163 | |
| 164 | |
| 165 | SkIPoint can be constructed or initialized by these functions, including C++ class constructors. |
| 166 | <table style='border-collapse: collapse; width: 62.5em'> |
| 167 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Topic</th> |
| 168 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 169 | <tr style='background-color: #f0f0f0; '> |
| 170 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_Make'>Make</a></td> |
| 171 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>constructs from integer inputs</td> |
| 172 | </tr> |
| 173 | </table> |
| 174 | |
| 175 | |
| 176 | <a name='SkIPoint_Make'></a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 177 | ## Make |
| 178 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 179 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 180 | static constexpr <a href='#SkIPoint'>SkIPoint</a> <a href='#SkIPoint_Make'>Make</a>(int32_t x, int32_t y) |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 181 | </pre> |
| 182 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 183 | Sets <a href='#SkIPoint_fX'>fX</a> to x, <a href='#SkIPoint_fY'>fY</a> to y. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 184 | |
| 185 | ### Parameters |
| 186 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 187 | <table> <tr> <td><a name='SkIPoint_Make_x'><code><strong>x</strong></code></a></td> |
| 188 | <td>integer x-axis value of constructed <a href='#IPoint'>IPoint</a></td> |
| 189 | </tr> |
| 190 | <tr> <td><a name='SkIPoint_Make_y'><code><strong>y</strong></code></a></td> |
| 191 | <td>integer y-axis value of constructed <a href='#IPoint'>IPoint</a></td> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 192 | </tr> |
| 193 | </table> |
| 194 | |
| 195 | ### Return Value |
| 196 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 197 | <a href='#IPoint'>IPoint</a> (x, y) |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 198 | |
| 199 | ### Example |
| 200 | |
| 201 | <div><fiddle-embed name="e5cf5159525bd3140f288a95fe641fae"> |
| 202 | |
| 203 | #### Example Output |
| 204 | |
| 205 | ~~~~ |
| 206 | pt1 == pt2 |
| 207 | ~~~~ |
| 208 | |
| 209 | </fiddle-embed></div> |
| 210 | |
| 211 | ### See Also |
| 212 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 213 | <a href='#SkIPoint_set'>set</a> <a href='SkPoint_Reference#SkPoint_iset'>SkPoint::iset()</a><sup><a href='SkPoint_Reference#SkPoint_iset_2'>[2]</a></sup> <a href='SkPoint_Reference#SkPoint_Make'>SkPoint::Make</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 214 | |
| 215 | --- |
| 216 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 217 | ## <a name='Property'>Property</a> |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 218 | |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 219 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 220 | <table style='border-collapse: collapse; width: 62.5em'> |
| 221 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Topic</th> |
| 222 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 223 | <tr style='background-color: #f0f0f0; '> |
| 224 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_isZero'>isZero</a></td> |
| 225 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>returns true if both members equal zero</td> |
| 226 | </tr> |
| 227 | <tr> |
| 228 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_x'>x</a></td> |
| 229 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>returns <a href='#SkIPoint_fX'>fX</a></td> |
| 230 | </tr> |
| 231 | <tr style='background-color: #f0f0f0; '> |
| 232 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_y'>y</a></td> |
| 233 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>returns <a href='#SkIPoint_fY'>fY</a></td> |
| 234 | </tr> |
| 235 | </table> |
| 236 | |
| 237 | |
| 238 | <a name='SkIPoint_x'></a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 239 | ## x |
| 240 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 241 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 242 | int32_t <a href='#SkIPoint_x'>x</a>() const |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 243 | </pre> |
| 244 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 245 | Returns x-axis value of <a href='#IPoint'>IPoint</a>. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 246 | |
| 247 | ### Return Value |
| 248 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 249 | <a href='#SkIPoint_fX'>fX</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 250 | |
| 251 | ### Example |
| 252 | |
| 253 | <div><fiddle-embed name="eed4185294f8a8216fc354e6ee6b2e3a"> |
| 254 | |
| 255 | #### Example Output |
| 256 | |
| 257 | ~~~~ |
| 258 | pt1.fX == pt1.x() |
| 259 | ~~~~ |
| 260 | |
| 261 | </fiddle-embed></div> |
| 262 | |
| 263 | ### See Also |
| 264 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 265 | <a href='#SkIPoint_y'>y</a> <a href='SkPoint_Reference#SkPoint_x'>SkPoint::x()</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 266 | |
| 267 | --- |
| 268 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 269 | <a name='SkIPoint_y'></a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 270 | ## y |
| 271 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 272 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 273 | int32_t <a href='#SkIPoint_y'>y</a>() const |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 274 | </pre> |
| 275 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 276 | Returns y-axis value of <a href='#IPoint'>IPoint</a>. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 277 | |
| 278 | ### Return Value |
| 279 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 280 | <a href='#SkIPoint_fY'>fY</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 281 | |
| 282 | ### Example |
| 283 | |
| 284 | <div><fiddle-embed name="35c41b8ba7cebf8c9a7a8494e610e14d"> |
| 285 | |
| 286 | #### Example Output |
| 287 | |
| 288 | ~~~~ |
| 289 | pt1.fY == pt1.y() |
| 290 | ~~~~ |
| 291 | |
| 292 | </fiddle-embed></div> |
| 293 | |
| 294 | ### See Also |
| 295 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 296 | <a href='#SkIPoint_x'>x</a> <a href='SkPoint_Reference#SkPoint_y'>SkPoint::y()</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 297 | |
| 298 | --- |
| 299 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 300 | <a name='SkIPoint_isZero'></a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 301 | ## isZero |
| 302 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 303 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 304 | bool <a href='#SkIPoint_isZero'>isZero</a>() const |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 305 | </pre> |
| 306 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 307 | Returns true if <a href='#SkIPoint_fX'>fX</a> and <a href='#SkIPoint_fY'>fY</a> are both zero. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 308 | |
| 309 | ### Return Value |
| 310 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 311 | true if <a href='#SkIPoint_fX'>fX</a> is zero and <a href='#SkIPoint_fY'>fY</a> is zero |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 312 | |
| 313 | ### Example |
| 314 | |
| 315 | <div><fiddle-embed name="658c1df611b4577cc7e0bb384e95737e"> |
| 316 | |
| 317 | #### Example Output |
| 318 | |
| 319 | ~~~~ |
| 320 | pt.isZero() == true |
| 321 | ~~~~ |
| 322 | |
| 323 | </fiddle-embed></div> |
| 324 | |
| 325 | ### See Also |
| 326 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 327 | <a href='SkPoint_Reference#SkPoint_isZero'>SkPoint::isZero</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 328 | |
| 329 | --- |
| 330 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 331 | ## <a name='Set'>Set</a> |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 332 | |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 333 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 334 | <table style='border-collapse: collapse; width: 62.5em'> |
| 335 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Topic</th> |
| 336 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 337 | <tr style='background-color: #f0f0f0; '> |
| 338 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_set'>set</a></td> |
| 339 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>sets to integer input</td> |
| 340 | </tr> |
| 341 | </table> |
| 342 | |
| 343 | |
| 344 | <a name='SkIPoint_set'></a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 345 | ## set |
| 346 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 347 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 348 | void <a href='#SkIPoint_set'>set</a>(int32_t x, int32_t y) |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 349 | </pre> |
| 350 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 351 | Sets <a href='#SkIPoint_fX'>fX</a> to x and <a href='#SkIPoint_fY'>fY</a> to y. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 352 | |
| 353 | ### Parameters |
| 354 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 355 | <table> <tr> <td><a name='SkIPoint_set_x'><code><strong>x</strong></code></a></td> |
| 356 | <td>new value for <a href='#SkIPoint_fX'>fX</a></td> |
| 357 | </tr> |
| 358 | <tr> <td><a name='SkIPoint_set_y'><code><strong>y</strong></code></a></td> |
| 359 | <td>new value for <a href='#SkIPoint_fY'>fY</a></td> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 360 | </tr> |
| 361 | </table> |
| 362 | |
| 363 | ### Example |
| 364 | |
| 365 | <div><fiddle-embed name="165418b5718d79d8f1682a8a0ee32ba0"> |
| 366 | |
| 367 | #### Example Output |
| 368 | |
| 369 | ~~~~ |
| 370 | pt1 == pt2 |
| 371 | ~~~~ |
| 372 | |
| 373 | </fiddle-embed></div> |
| 374 | |
| 375 | ### See Also |
| 376 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 377 | <a href='#SkIPoint_Make'>Make</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 378 | |
| 379 | --- |
| 380 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 381 | ## <a name='Operator'>Operator</a> |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 382 | |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 383 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 384 | SkIPoint operators inline class member functions with arithmetic equivalents. |
| 385 | <table style='border-collapse: collapse; width: 62.5em'> |
| 386 | <tr><th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Topic</th> |
| 387 | <th style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>Description</th></tr> |
| 388 | <tr style='background-color: #f0f0f0; '> |
| 389 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_equals'>equals</a></td> |
| 390 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>returns true if members are equal</td> |
| 391 | </tr> |
| 392 | <tr> |
| 393 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_notequal_operator'>operator!=(const SkIPoint& a, const SkIPoint& b)</a></td> |
| 394 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>returns true if <a href='#IPoint'>IPoints</a> are unequal</td> |
| 395 | </tr> |
| 396 | <tr style='background-color: #f0f0f0; '> |
| 397 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_add_operator'>operator+(const SkIPoint& a, const SkIVector& b)</a></td> |
| 398 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>returns <a href='#IPoint'>IPoint</a> offset by <a href='#IVector'>IVector</a></td> |
| 399 | </tr> |
| 400 | <tr> |
| 401 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_addto_operator'>operator+=(const SkIVector& v)</a></td> |
| 402 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>adds <a href='#IVector'>IVector</a> to <a href='#IPoint'>IPoint</a></td> |
| 403 | </tr> |
| 404 | <tr style='background-color: #f0f0f0; '> |
| 405 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_minus_operator'>operator-() const</a></td> |
| 406 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>reverses sign of <a href='#IPoint'>IPoint</a></td> |
| 407 | </tr> |
| 408 | <tr> |
| 409 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_subtract_operator'>operator-(const SkIPoint& a, const SkIPoint& b)</a></td> |
| 410 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>returns <a href='#IVector'>IVector</a> between <a href='#IPoint'>IPoints</a></td> |
| 411 | </tr> |
| 412 | <tr style='background-color: #f0f0f0; '> |
| 413 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_subtractfrom_operator'>operator-=(const SkIVector& v)</a></td> |
| 414 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>subtracts <a href='#IVector'>IVector</a> from <a href='#IPoint'>IPoint</a></td> |
| 415 | </tr> |
| 416 | <tr> |
| 417 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '><a href='#SkIPoint_equal_operator'>operator==(const SkIPoint& a, const SkIPoint& b)</a></td> |
| 418 | <td style='text-align: left; border: 2px solid #dddddd; padding: 8px; '>returns true if <a href='#IPoint'>IPoints</a> are equal</td> |
| 419 | </tr> |
| 420 | </table> |
| 421 | |
| 422 | |
| 423 | <a name='SkIPoint_minus_operator'></a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 424 | ## operator- |
| 425 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 426 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 427 | <a href='#SkIPoint'>SkIPoint</a> operator-() _const |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 428 | </pre> |
| 429 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 430 | Returns <a href='#IPoint'>IPoint</a> changing the signs of <a href='#SkIPoint_fX'>fX</a> and <a href='#SkIPoint_fY'>fY</a>. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 431 | |
| 432 | ### Return Value |
| 433 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 434 | <a href='#IPoint'>IPoint</a> as (-<a href='#SkIPoint_fX'>fX</a>, -<a href='#SkIPoint_fY'>fY</a>) |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 435 | |
| 436 | ### Example |
| 437 | |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 438 | <div><fiddle-embed name="b30d4780475d113a7fed3637af7f0db1"> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 439 | |
| 440 | #### Example Output |
| 441 | |
| 442 | ~~~~ |
| 443 | pt: 0, 0 negate: 0, 0 |
| 444 | pt: -1, -2 negate: 1, 2 |
| 445 | pt: 2147483647, -2147483647 negate: -2147483647, 2147483647 |
| 446 | pt: -2147483648, -2147483648 negate: -2147483648, -2147483648 |
| 447 | ~~~~ |
| 448 | |
| 449 | </fiddle-embed></div> |
| 450 | |
| 451 | ### See Also |
| 452 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 453 | <a href='#SkIPoint_subtract_operator'>operator-(const SkIPoint& a, const SkIPoint& b)</a> <a href='#SkIPoint_subtractfrom_operator'>operator-=(const SkIVector& v)</a> <a href='SkPoint_Reference#SkPoint_minus_operator'>SkPoint::operator-() const</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 454 | |
| 455 | --- |
| 456 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 457 | <a name='SkIPoint_addto_operator'></a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 458 | ## operator+= |
| 459 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 460 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 461 | void <a href='#SkIPoint_addto_operator'>operator+=(const SkIVector& v)</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 462 | </pre> |
| 463 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 464 | Offsets <a href='#IPoint'>IPoint</a> by <a href='#IVector'>IVector</a> <a href='#SkIPoint_addto_operator_v'>v</a>. Sets <a href='#IPoint'>IPoint</a> to(<a href='#SkIPoint_fX'>fX</a> + <a href='#SkIPoint_addto_operator_v'>v</a>.<a href='#SkIPoint_fX'>fX</a>, <a href='#SkIPoint_fY'>fY</a> + <a href='#SkIPoint_addto_operator_v'>v</a>.<a href='#SkIPoint_fY'>fY</a>) |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 465 | . |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 466 | |
| 467 | ### Parameters |
| 468 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 469 | <table> <tr> <td><a name='SkIPoint_addto_operator_v'><code><strong>v</strong></code></a></td> |
| 470 | <td><a href='#IVector'>IVector</a> to add</td> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 471 | </tr> |
| 472 | </table> |
| 473 | |
| 474 | ### Example |
| 475 | |
| 476 | <div><fiddle-embed name="4eb2d95c9e9a66f05296e345bb68bd51"></fiddle-embed></div> |
| 477 | |
| 478 | ### See Also |
| 479 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 480 | <a href='#SkIPoint_add_operator'>operator+(const SkIPoint& a, const SkIVector& b)</a> <a href='SkPoint_Reference#SkPoint_addto_operator'>SkPoint::operator+=(const SkVector& v)</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 481 | |
| 482 | --- |
| 483 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 484 | <a name='SkIPoint_subtractfrom_operator'></a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 485 | ## operator-= |
| 486 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 487 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 488 | void <a href='#SkIPoint_subtractfrom_operator'>operator-=(const SkIVector& v)</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 489 | </pre> |
| 490 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 491 | Subtracts <a href='#IVector'>IVector</a> <a href='#SkIPoint_subtractfrom_operator_v'>v</a> from <a href='#IPoint'>IPoint</a>. Sets <a href='#IPoint'>IPoint</a> to: |
| 492 | (<a href='#SkIPoint_fX'>fX</a> - <a href='#SkIPoint_subtractfrom_operator_v'>v</a>.<a href='#SkIPoint_fX'>fX</a>, <a href='#SkIPoint_fY'>fY</a> - <a href='#SkIPoint_subtractfrom_operator_v'>v</a>.<a href='#SkIPoint_fY'>fY</a>) |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 493 | . |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 494 | |
| 495 | ### Parameters |
| 496 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 497 | <table> <tr> <td><a name='SkIPoint_subtractfrom_operator_v'><code><strong>v</strong></code></a></td> |
| 498 | <td><a href='#IVector'>IVector</a> to subtract</td> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 499 | </tr> |
| 500 | </table> |
| 501 | |
| 502 | ### Example |
| 503 | |
| 504 | <div><fiddle-embed name="a01e533dc7ab34ed728dc4e7a5f1f0ee"></fiddle-embed></div> |
| 505 | |
| 506 | ### See Also |
| 507 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 508 | <a href='#SkIPoint_subtract_operator'>operator-(const SkIPoint& a, const SkIPoint& b)</a> <a href='SkPoint_Reference#SkPoint_subtractfrom_operator'>SkPoint::operator-=(const SkVector& v)</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 509 | |
| 510 | --- |
| 511 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 512 | <a name='SkIPoint_equals'></a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 513 | ## equals |
| 514 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 515 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 516 | bool <a href='#SkIPoint_equals'>equals</a>(int32_t x, int32_t y) const |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 517 | </pre> |
| 518 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 519 | Returns true if <a href='#IPoint'>IPoint</a> is equivalent to <a href='#IPoint'>IPoint</a> constructed from (x, y). |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 520 | |
| 521 | ### Parameters |
| 522 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 523 | <table> <tr> <td><a name='SkIPoint_equals_x'><code><strong>x</strong></code></a></td> |
| 524 | <td>value compared with <a href='#SkIPoint_fX'>fX</a></td> |
| 525 | </tr> |
| 526 | <tr> <td><a name='SkIPoint_equals_y'><code><strong>y</strong></code></a></td> |
| 527 | <td>value compared with <a href='#SkIPoint_fY'>fY</a></td> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 528 | </tr> |
| 529 | </table> |
| 530 | |
| 531 | ### Return Value |
| 532 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 533 | true if <a href='#IPoint'>IPoint</a> equals (x, y) |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 534 | |
| 535 | ### Example |
| 536 | |
| 537 | <div><fiddle-embed name="64f575d36439d5b69aaed14ffeff1cc4"> |
| 538 | |
| 539 | #### Example Output |
| 540 | |
| 541 | ~~~~ |
| 542 | pt: 0, 0 == pt |
| 543 | pt: -1, -2 == pt |
| 544 | pt: 2147483647, -1 == pt |
| 545 | pt: -2147483648, -1 == pt |
| 546 | ~~~~ |
| 547 | |
| 548 | </fiddle-embed></div> |
| 549 | |
| 550 | ### See Also |
| 551 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 552 | <a href='#SkIPoint_equal_operator'>operator==(const SkIPoint& a, const SkIPoint& b)</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 553 | |
| 554 | --- |
| 555 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 556 | <a name='SkIPoint_equal_operator'></a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 557 | ## operator== |
| 558 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 559 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 560 | bool <a href='#SkIPoint_equal_operator'>operator==(const SkIPoint& a, const SkIPoint& b)</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 561 | </pre> |
| 562 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 563 | Returns true if <a href='#SkIPoint_equal_operator_a'>a</a> is equivalent to <a href='#SkIPoint_equal_operator_b'>b</a>. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 564 | |
| 565 | ### Parameters |
| 566 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 567 | <table> <tr> <td><a name='SkIPoint_equal_operator_a'><code><strong>a</strong></code></a></td> |
| 568 | <td><a href='#IPoint'>IPoint</a> to compare</td> |
| 569 | </tr> |
| 570 | <tr> <td><a name='SkIPoint_equal_operator_b'><code><strong>b</strong></code></a></td> |
| 571 | <td><a href='#IPoint'>IPoint</a> to compare</td> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 572 | </tr> |
| 573 | </table> |
| 574 | |
| 575 | ### Return Value |
| 576 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 577 | true if <a href='#SkIPoint_equal_operator_a'>a</a>.<a href='#SkIPoint_fX'>fX</a> == <a href='#SkIPoint_equal_operator_b'>b</a>.<a href='#SkIPoint_fX'>fX</a> and <a href='#SkIPoint_equal_operator_a'>a</a>.<a href='#SkIPoint_fY'>fY</a> == <a href='#SkIPoint_equal_operator_b'>b</a>.<a href='#SkIPoint_fY'>fY</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 578 | |
| 579 | ### Example |
| 580 | |
| 581 | <div><fiddle-embed name="37ffe2817d720f99e6c252332ce70460"> |
| 582 | |
| 583 | #### Example Output |
| 584 | |
| 585 | ~~~~ |
| 586 | pt: 0, 0 == pt |
| 587 | pt: -1, -2 == pt |
| 588 | pt: 2147483647, -1 == pt |
| 589 | pt: -2147483648, -1 == pt |
| 590 | ~~~~ |
| 591 | |
| 592 | </fiddle-embed></div> |
| 593 | |
| 594 | ### See Also |
| 595 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 596 | <a href='#SkIPoint_equals'>equals</a> <a href='#SkIPoint_notequal_operator'>operator!=(const SkIPoint& a, const SkIPoint& b)</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 597 | |
| 598 | --- |
| 599 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 600 | <a name='SkIPoint_notequal_operator'></a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 601 | ## operator!= |
| 602 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 603 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 604 | bool <a href='#SkIPoint_notequal_operator'>operator!=(const SkIPoint& a, const SkIPoint& b)</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 605 | </pre> |
| 606 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 607 | Returns true if <a href='#SkIPoint_notequal_operator_a'>a</a> is not equivalent to <a href='#SkIPoint_notequal_operator_b'>b</a>. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 608 | |
| 609 | ### Parameters |
| 610 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 611 | <table> <tr> <td><a name='SkIPoint_notequal_operator_a'><code><strong>a</strong></code></a></td> |
| 612 | <td><a href='#IPoint'>IPoint</a> to compare</td> |
| 613 | </tr> |
| 614 | <tr> <td><a name='SkIPoint_notequal_operator_b'><code><strong>b</strong></code></a></td> |
| 615 | <td><a href='#IPoint'>IPoint</a> to compare</td> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 616 | </tr> |
| 617 | </table> |
| 618 | |
| 619 | ### Return Value |
| 620 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 621 | true if <a href='#SkIPoint_notequal_operator_a'>a</a>.<a href='#SkIPoint_fX'>fX</a> != <a href='#SkIPoint_notequal_operator_b'>b</a>.<a href='#SkIPoint_fX'>fX</a> or <a href='#SkIPoint_notequal_operator_a'>a</a>.<a href='#SkIPoint_fY'>fY</a> != <a href='#SkIPoint_notequal_operator_b'>b</a>.<a href='#SkIPoint_fY'>fY</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 622 | |
| 623 | ### Example |
| 624 | |
| 625 | <div><fiddle-embed name="dd89dc48dff69b53d99530b120f204bc"> |
| 626 | |
| 627 | #### Example Output |
| 628 | |
| 629 | ~~~~ |
| 630 | pt: 0, 0 == pt |
| 631 | pt: -1, -2 == pt |
| 632 | pt: 2147483647, -1 == pt |
| 633 | pt: -2147483648, -1 == pt |
| 634 | ~~~~ |
| 635 | |
| 636 | </fiddle-embed></div> |
| 637 | |
| 638 | ### See Also |
| 639 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 640 | <a href='#SkIPoint_equal_operator'>operator==(const SkIPoint& a, const SkIPoint& b)</a> <a href='#SkIPoint_equals'>equals</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 641 | |
| 642 | --- |
| 643 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 644 | <a name='SkIPoint_subtract_operator'></a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 645 | ## operator- |
| 646 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 647 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 648 | <a href='#SkIVector'>SkIVector</a> <a href='#SkIPoint_subtract_operator'>operator-(const SkIPoint& a, const SkIPoint& b)</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 649 | </pre> |
| 650 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 651 | Returns <a href='#IVector'>IVector</a> from <a href='#SkIPoint_subtract_operator_b'>b</a> to <a href='#SkIPoint_subtract_operator_a'>a</a>; computed as(<a href='#SkIPoint_subtract_operator_a'>a</a>.<a href='#SkIPoint_fX'>fX</a> - <a href='#SkIPoint_subtract_operator_b'>b</a>.<a href='#SkIPoint_fX'>fX</a>, <a href='#SkIPoint_subtract_operator_a'>a</a>.<a href='#SkIPoint_fY'>fY</a> - <a href='#SkIPoint_subtract_operator_b'>b</a>.<a href='#SkIPoint_fY'>fY</a>) |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 652 | . |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 653 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 654 | Can also be used to subtract <a href='#IVector'>IVector</a> from <a href='#IVector'>IVector</a>, returning <a href='#IVector'>IVector</a>. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 655 | |
| 656 | ### Parameters |
| 657 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 658 | <table> <tr> <td><a name='SkIPoint_subtract_operator_a'><code><strong>a</strong></code></a></td> |
| 659 | <td><a href='#IPoint'>IPoint</a> or <a href='#IVector'>IVector</a> to subtract from</td> |
| 660 | </tr> |
| 661 | <tr> <td><a name='SkIPoint_subtract_operator_b'><code><strong>b</strong></code></a></td> |
| 662 | <td><a href='#IVector'>IVector</a> to subtract</td> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 663 | </tr> |
| 664 | </table> |
| 665 | |
| 666 | ### Return Value |
| 667 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 668 | <a href='#IVector'>IVector</a> from <a href='#SkIPoint_subtract_operator_b'>b</a> to <a href='#SkIPoint_subtract_operator_a'>a</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 669 | |
| 670 | ### Example |
| 671 | |
| 672 | <div><fiddle-embed name="e626e26bf557857b824aa7d03f723e0f"></fiddle-embed></div> |
| 673 | |
| 674 | ### See Also |
| 675 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 676 | <a href='#SkIPoint_subtractfrom_operator'>operator-=(const SkIVector& v)</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 677 | |
| 678 | --- |
| 679 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 680 | <a name='SkIPoint_add_operator'></a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 681 | ## operator+ |
| 682 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 683 | <pre style="padding: 1em 1em 1em 1em; width: 62.5em;background-color: #f0f0f0"> |
| 684 | <a href='#SkIPoint'>SkIPoint</a> <a href='#SkIPoint_add_operator'>operator+(const SkIPoint& a, const SkIVector& b)</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 685 | </pre> |
| 686 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 687 | Returns <a href='#IPoint'>IPoint</a> resulting from <a href='#IPoint'>IPoint</a> <a href='#SkIPoint_add_operator_a'>a</a> offset by <a href='#IVector'>IVector</a> <a href='#SkIPoint_add_operator_b'>b</a>, computed as: |
| 688 | (<a href='#SkIPoint_add_operator_a'>a</a>.<a href='#SkIPoint_fX'>fX</a> + <a href='#SkIPoint_add_operator_b'>b</a>.<a href='#SkIPoint_fX'>fX</a>, <a href='#SkIPoint_add_operator_a'>a</a>.<a href='#SkIPoint_fY'>fY</a> + <a href='#SkIPoint_add_operator_b'>b</a>.<a href='#SkIPoint_fY'>fY</a>) |
Cary Clark | 1a8d762 | 2018-03-05 13:26:16 -0500 | [diff] [blame] | 689 | . |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 690 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 691 | Can also be used to offset <a href='#IPoint'>IPoint</a> <a href='#SkIPoint_add_operator_b'>b</a> by <a href='#IVector'>IVector</a> <a href='#SkIPoint_add_operator_a'>a</a>, returning <a href='#IPoint'>IPoint</a>. |
| 692 | Can also be used to add <a href='#IVector'>IVector</a> to <a href='#IVector'>IVector</a>, returning <a href='#IVector'>IVector</a>. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 693 | |
| 694 | ### Parameters |
| 695 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 696 | <table> <tr> <td><a name='SkIPoint_add_operator_a'><code><strong>a</strong></code></a></td> |
| 697 | <td><a href='#IPoint'>IPoint</a> or <a href='#IVector'>IVector</a> to add to</td> |
| 698 | </tr> |
| 699 | <tr> <td><a name='SkIPoint_add_operator_b'><code><strong>b</strong></code></a></td> |
| 700 | <td><a href='#IPoint'>IPoint</a> or <a href='#IVector'>IVector</a> to add</td> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 701 | </tr> |
| 702 | </table> |
| 703 | |
| 704 | ### Return Value |
| 705 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 706 | <a href='#IPoint'>IPoint</a> equal to <a href='#SkIPoint_add_operator_a'>a</a> offset by <a href='#SkIPoint_add_operator_b'>b</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 707 | |
| 708 | ### Example |
| 709 | |
| 710 | <div><fiddle-embed name="63f4cba971c6d8434595906f865b5a29"></fiddle-embed></div> |
| 711 | |
| 712 | ### See Also |
| 713 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 714 | <a href='#SkIPoint_addto_operator'>operator+=(const SkIVector& v)</a> |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 715 | |
| 716 | --- |
| 717 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame^] | 718 | ## <a name='IVector'>IVector</a> |
| 719 | |
| 720 | # <a name='SkIVector'>Typedef SkIVector</a> |
| 721 | |
| 722 | <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> |
| 723 | typedef <a href='#SkIPoint'>SkIPoint</a> <a href='#SkIVector'>SkIVector</a>; |
| 724 | </pre> |
| 725 | |
| 726 | <a href='#SkIVector'>SkIVector</a> provides an alternative name for <a href='#SkIPoint'>SkIPoint</a>. <a href='#SkIVector'>SkIVector</a> and <a href='#SkIPoint'>SkIPoint</a> |
| 727 | can be used interchangably for all purposes. |