skia2/site/user/api/SkIPoint16_Reference.md
Cary Clark 2a8c48be4f improve bookmaker defines and references
generating replacement includes exposed
errors mostly dealing with globals like
SkAlphaType and members. Rewrite finding
and resolving links to hopefully make this
area more robust.

TBR=caryclark@google.com
Docs-Preview: https://skia.org/?cl=107160
Bug: skia:6898
Change-Id: I9b8025160203d204286f3f6ca0cebd70da6253b4
Reviewed-on: https://skia-review.googlesource.com/107160
Commit-Queue: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-02-16 15:35:36 +00:00

211 lines
5.1 KiB
Markdown

SkIPoint16 Reference
===
# <a name="IPoint16"></a> IPoint16
## <a name="Overview"></a> Overview
## <a name="Overview_Subtopic"></a> Overview Subtopic
| name | description |
| --- | --- |
| <a href="#Constructor">Constructor</a> | functions that construct <a href="#SkIPoint16">SkIPoint16</a> |
| <a href="#Member_Function">Member Function</a> | static functions and member methods |
| <a href="#Member">Member</a> | member values |
| <a href="#Related_Function">Related Function</a> | similar methods grouped together |
# <a name="SkIPoint16"></a> Struct SkIPoint16
<a href="#SkIPoint16">SkIPoint16</a> holds two 16 bit integer coordinates.
## <a name="Related_Function"></a> Related Function
| name | description |
| --- | --- |
| <a href="#Property">Property</a> | member values |
| <a href="#Set">Set</a> | replaces all values |
## <a name="Member_Function"></a> Member Function
| name | description |
| --- | --- |
| <a href="#SkIPoint16_Make">Make</a> | constructs from integer inputs |
| <a href="#SkIPoint16_set">set</a> | sets to integer input |
| <a href="#SkIPoint16_x">x</a> | returns <a href="#SkIPoint16_fX">fX</a> |
| <a href="#SkIPoint16_y">y</a> | returns <a href="#SkIPoint16_fY">fY</a> |
## <a name="Member"></a> Member
| name | description |
| --- | --- |
| <a href="#SkIPoint16_fX">fX</a> | x-axis value |
| <a href="#SkIPoint16_fY">fY</a> | y-axis value |
<a name="SkIPoint16_fX"> <code><strong>int16_t fX</strong></code> </a>
x-axis value used by <a href="#IPoint16">IPoint16</a>
<a name="SkIPoint16_fY"> <code><strong>int16_t fY</strong></code> </a>
y-axis value used by <a href="#IPoint16">IPoint16</a>
## <a name="Constructor"></a> Constructor
| name | description |
| --- | --- |
| <a href="#SkIPoint16_Make">Make</a> | constructs from integer inputs |
<a name="SkIPoint16_Make"></a>
## Make
<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0">
static constexpr SkIPoint16 Make(int x, int y)
</pre>
Sets <a href="#SkIPoint16_fX">fX</a> to x, <a href="#SkIPoint16_fY">fY</a> to y. If SK_DEBUG is defined, asserts
if x or y does not fit in 16 bits.
### Parameters
<table> <tr> <td><a name="SkIPoint16_Make_x"> <code><strong>x </strong></code> </a></td> <td>
integer x-axis value of constructed <a href="SkIPoint_Reference#IPoint">IPoint</a></td>
</tr> <tr> <td><a name="SkIPoint16_Make_y"> <code><strong>y </strong></code> </a></td> <td>
integer y-axis value of constructed <a href="SkIPoint_Reference#IPoint">IPoint</a></td>
</tr>
</table>
### Return Value
<a href="#IPoint16">IPoint16</a> (x, y)
### Example
<div><fiddle-embed name="d815ca04fbf22b5acec6f85b6351f362">
#### Example Output
~~~~
pt1.fX == pt2.fX
pt1.fY == pt2.fY
~~~~
</fiddle-embed></div>
### See Also
<a href="#SkIPoint16_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="SkIPoint_Reference#SkIPoint_Make">SkIPoint::Make</a>
---
## <a name="Property"></a> Property
| name | description |
| --- | --- |
| <a href="#SkIPoint16_x">x</a> | returns <a href="#SkIPoint16_fX">fX</a> |
| <a href="#SkIPoint16_y">y</a> | returns <a href="#SkIPoint16_fY">fY</a> |
<a name="SkIPoint16_x"></a>
## x
<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0">
int16_t x() const
</pre>
Returns x-axis value of <a href="#IPoint16">IPoint16</a>.
### Return Value
<a href="#SkIPoint16_fX">fX</a>
### Example
<div><fiddle-embed name="f7fd3b3674f042869de3582ab793dbf7">
#### Example Output
~~~~
pt1.fX == pt1.x()
~~~~
</fiddle-embed></div>
### See Also
<a href="#SkIPoint16_y">y</a> <a href="SkIPoint_Reference#SkIPoint_x">SkIPoint::x()</a>
---
<a name="SkIPoint16_y"></a>
## y
<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0">
int16_t y() const
</pre>
Returns y-axis value of <a href="SkIPoint_Reference#IPoint">IPoint</a>.
### Return Value
<a href="#SkIPoint16_fY">fY</a>
### Example
<div><fiddle-embed name="3662cedaf1e9924a401f794902da3b1f">
#### Example Output
~~~~
pt1.fY == pt1.y()
~~~~
</fiddle-embed></div>
### See Also
<a href="#SkIPoint16_x">x</a> <a href="SkPoint_Reference#SkPoint_y">SkPoint::y()</a> <a href="SkIPoint_Reference#SkIPoint_y">SkIPoint::y()</a>
---
## <a name="Set"></a> Set
| name | description |
| --- | --- |
| <a href="#SkIPoint16_set">set</a> | sets to integer input |
<a name="SkIPoint16_set"></a>
## set
<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0">
void set(int x, int y)
</pre>
Sets <a href="#SkIPoint16_fX">fX</a> to x and <a href="#SkIPoint16_fY">fY</a> to y.
### Parameters
<table> <tr> <td><a name="SkIPoint16_set_x"> <code><strong>x </strong></code> </a></td> <td>
new value for <a href="#SkIPoint16_fX">fX</a></td>
</tr> <tr> <td><a name="SkIPoint16_set_y"> <code><strong>y </strong></code> </a></td> <td>
new value for <a href="#SkIPoint16_fY">fY</a></td>
</tr>
</table>
### Example
<div><fiddle-embed name="abff78d3f2d97b1284ccb13d0c56b6c8">
#### Example Output
~~~~
pt1.fX == pt2.fX
pt1.fY == pt2.fY
~~~~
</fiddle-embed></div>
### See Also
<a href="#SkIPoint16_Make">Make</a> <a href="SkPoint_Reference#SkPoint_set">SkPoint::set</a>
---