blob: e4d08b42af1f95c4ec16f6c0541570805ee072d8 [file] [log] [blame]
Cary Clarka560c472017-11-27 10:44:06 -05001#Topic IPoint16
2#Alias IPoint16_Reference
3
Cary Clark08895c42018-02-01 09:37:32 -05004#Subtopic Overview
5 #Subtopic Subtopics
6 #Populate
7 ##
8##
9
Cary Clarka560c472017-11-27 10:44:06 -050010#Struct SkIPoint16
11
Cary Clarkab2621d2018-01-30 10:08:57 -050012SkIPoint16 holds two 16 bit integer coordinates.
Cary Clarka560c472017-11-27 10:44:06 -050013
Cary Clark5081eed2018-01-22 07:55:48 -050014#Subtopic Constructors
Cary Clark08895c42018-02-01 09:37:32 -050015#Populate
16##
Cary Clarka560c472017-11-27 10:44:06 -050017
18#Subtopic Member_Functions
Cary Clark08895c42018-02-01 09:37:32 -050019#Populate
20##
Cary Clarka560c472017-11-27 10:44:06 -050021
Cary Clark08895c42018-02-01 09:37:32 -050022#Subtopic Members
23#Populate
Cary Clarka560c472017-11-27 10:44:06 -050024
25#Member int16_t fX
Cary Clark08895c42018-02-01 09:37:32 -050026#Line # x-axis value ##
Cary Clark5081eed2018-01-22 07:55:48 -050027x-axis value used by IPoint16
Cary Clarka560c472017-11-27 10:44:06 -050028##
29
30#Member int16_t fY
Cary Clark08895c42018-02-01 09:37:32 -050031#Line # y-axis value ##
Cary Clark5081eed2018-01-22 07:55:48 -050032y-axis value used by IPoint16
Cary Clarka560c472017-11-27 10:44:06 -050033##
34
Cary Clark08895c42018-02-01 09:37:32 -050035#Subtopic Members ##
36
Cary Clarka560c472017-11-27 10:44:06 -050037# ------------------------------------------------------------------------------
38
39#Method static constexpr SkIPoint16 Make(int x, int y)
40
Cary Clarkab2621d2018-01-30 10:08:57 -050041#Line # constructs from integer inputs ##
Cary Clarka560c472017-11-27 10:44:06 -050042Sets fX to x, fY to y. If SK_DEBUG is defined, asserts
43if x or y does not fit in 16 bits.
44
45#Param x integer x-axis value of constructed IPoint ##
46#Param y integer y-axis value of constructed IPoint ##
47
48#Return IPoint16 (x, y) ##
49
50#Example
51SkIPoint16 pt1 = {45, 66};
52SkIPoint16 pt2 = SkIPoint16::Make(45, 66);
53SkDebugf("pt1.fX %c= pt2.fX\n", pt1.fX == pt2.fX ? '=' : '!');
54SkDebugf("pt1.fY %c= pt2.fY\n", pt1.fY == pt2.fY ? '=' : '!');
55#StdOut
56pt1.fX == pt2.fX
57pt1.fY == pt2.fY
58##
59##
60
61#SeeAlso set() SkPoint::iset() SkIPoint::Make
62
63#Method ##
64
65# ------------------------------------------------------------------------------
66
67#Method int16_t x() const
68
Cary Clarkab2621d2018-01-30 10:08:57 -050069#Line # returns fX ##
Cary Clarka560c472017-11-27 10:44:06 -050070Returns x-axis value of IPoint16.
71
72#Return fX ##
73
74#Example
75SkIPoint16 pt1 = {45, 66};
76SkDebugf("pt1.fX %c= pt1.x()\n", pt1.fX == pt1.x() ? '=' : '!');
77#StdOut
78pt1.fX == pt1.x()
79##
80##
81
82#SeeAlso y() SkIPoint::x()
83
84#Method ##
85
86# ------------------------------------------------------------------------------
87
88#Method int16_t y() const
89
Cary Clarkab2621d2018-01-30 10:08:57 -050090#Line # returns fY ##
Cary Clarka560c472017-11-27 10:44:06 -050091Returns y-axis value of IPoint.
92
93#Return fY ##
94
95#Example
96SkIPoint16 pt1 = {45, 66};
97SkDebugf("pt1.fY %c= pt1.y()\n", pt1.fY == pt1.y() ? '=' : '!');
98#StdOut
99pt1.fY == pt1.y()
100##
101##
102
103#SeeAlso x() SkPoint::y() SkIPoint::y()
104
105#Method ##
106
107# ------------------------------------------------------------------------------
108
109#Method void set(int x, int y)
110
Cary Clarkab2621d2018-01-30 10:08:57 -0500111#Line # sets to integer input ##
Cary Clarka560c472017-11-27 10:44:06 -0500112Sets fX to x and fY to y.
113
114#Param x new value for fX ##
115#Param y new value for fY ##
116
117#Example
118SkIPoint16 pt1, pt2 = { SK_MinS16, SK_MaxS16 };
119pt1.set(SK_MinS16, SK_MaxS16);
120SkDebugf("pt1.fX %c= pt2.fX\n", pt1.fX == pt2.fX ? '=' : '!');
121SkDebugf("pt1.fY %c= pt2.fY\n", pt1.fY == pt2.fY ? '=' : '!');
122#StdOut
123pt1.fX == pt2.fX
124pt1.fY == pt2.fY
125##
126##
127
128#SeeAlso Make SkPoint::set
129
130#Method ##
131
132#Struct SkIPoint16 ##
133
134#Topic IPoint16 ##