blob: 7d6c872831b0a8f6e56d64dd9f685a291161a4f7 [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
Cary Clark4855f782018-02-06 09:41:53 -05005 #Subtopic Subtopic
Cary Clark08895c42018-02-01 09:37:32 -05006 #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 Clark4855f782018-02-06 09:41:53 -050014#Subtopic Related_Function
Cary Clark08895c42018-02-01 09:37:32 -050015#Populate
16##
Cary Clarka560c472017-11-27 10:44:06 -050017
Cary Clark4855f782018-02-06 09:41:53 -050018#Subtopic Member_Function
Cary Clark08895c42018-02-01 09:37:32 -050019#Populate
20##
Cary Clarka560c472017-11-27 10:44:06 -050021
Cary Clark4855f782018-02-06 09:41:53 -050022#Subtopic Member
Cary Clark08895c42018-02-01 09:37:32 -050023#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 Clark4855f782018-02-06 09:41:53 -050035#Subtopic Member ##
Cary Clark08895c42018-02-01 09:37:32 -050036
Cary Clarka560c472017-11-27 10:44:06 -050037# ------------------------------------------------------------------------------
38
Cary Clark4855f782018-02-06 09:41:53 -050039#Subtopic Constructor
40#Populate
41##
42
Cary Clarka560c472017-11-27 10:44:06 -050043#Method static constexpr SkIPoint16 Make(int x, int y)
44
Cary Clark4855f782018-02-06 09:41:53 -050045#In Constructor
Cary Clarkab2621d2018-01-30 10:08:57 -050046#Line # constructs from integer inputs ##
Cary Clarka560c472017-11-27 10:44:06 -050047Sets fX to x, fY to y. If SK_DEBUG is defined, asserts
48if x or y does not fit in 16 bits.
49
50#Param x integer x-axis value of constructed IPoint ##
51#Param y integer y-axis value of constructed IPoint ##
52
53#Return IPoint16 (x, y) ##
54
55#Example
56SkIPoint16 pt1 = {45, 66};
57SkIPoint16 pt2 = SkIPoint16::Make(45, 66);
58SkDebugf("pt1.fX %c= pt2.fX\n", pt1.fX == pt2.fX ? '=' : '!');
59SkDebugf("pt1.fY %c= pt2.fY\n", pt1.fY == pt2.fY ? '=' : '!');
60#StdOut
61pt1.fX == pt2.fX
62pt1.fY == pt2.fY
63##
64##
65
66#SeeAlso set() SkPoint::iset() SkIPoint::Make
67
68#Method ##
69
70# ------------------------------------------------------------------------------
71
Cary Clark4855f782018-02-06 09:41:53 -050072#Subtopic Property
73#Line # member values ##
74#Populate
75##
76
Cary Clarka560c472017-11-27 10:44:06 -050077#Method int16_t x() const
78
Cary Clark4855f782018-02-06 09:41:53 -050079#In Property
Cary Clarkab2621d2018-01-30 10:08:57 -050080#Line # returns fX ##
Cary Clarka560c472017-11-27 10:44:06 -050081Returns x-axis value of IPoint16.
82
83#Return fX ##
84
85#Example
86SkIPoint16 pt1 = {45, 66};
87SkDebugf("pt1.fX %c= pt1.x()\n", pt1.fX == pt1.x() ? '=' : '!');
88#StdOut
89pt1.fX == pt1.x()
90##
91##
92
93#SeeAlso y() SkIPoint::x()
94
95#Method ##
96
97# ------------------------------------------------------------------------------
98
99#Method int16_t y() const
Cary Clark4855f782018-02-06 09:41:53 -0500100#In Property
Cary Clarkab2621d2018-01-30 10:08:57 -0500101#Line # returns fY ##
Cary Clarka560c472017-11-27 10:44:06 -0500102Returns y-axis value of IPoint.
103
104#Return fY ##
105
106#Example
107SkIPoint16 pt1 = {45, 66};
108SkDebugf("pt1.fY %c= pt1.y()\n", pt1.fY == pt1.y() ? '=' : '!');
109#StdOut
110pt1.fY == pt1.y()
111##
112##
113
114#SeeAlso x() SkPoint::y() SkIPoint::y()
115
116#Method ##
117
118# ------------------------------------------------------------------------------
119
Cary Clark4855f782018-02-06 09:41:53 -0500120#Subtopic Set
121#Populate
122#Line # replaces all values ##
123##
Cary Clarka560c472017-11-27 10:44:06 -0500124
Cary Clark4855f782018-02-06 09:41:53 -0500125#Method void set(int x, int y)
126#In Set
Cary Clarkab2621d2018-01-30 10:08:57 -0500127#Line # sets to integer input ##
Cary Clarka560c472017-11-27 10:44:06 -0500128Sets fX to x and fY to y.
129
130#Param x new value for fX ##
131#Param y new value for fY ##
132
133#Example
134SkIPoint16 pt1, pt2 = { SK_MinS16, SK_MaxS16 };
135pt1.set(SK_MinS16, SK_MaxS16);
136SkDebugf("pt1.fX %c= pt2.fX\n", pt1.fX == pt2.fX ? '=' : '!');
137SkDebugf("pt1.fY %c= pt2.fY\n", pt1.fY == pt2.fY ? '=' : '!');
138#StdOut
139pt1.fX == pt2.fX
140pt1.fY == pt2.fY
141##
142##
143
144#SeeAlso Make SkPoint::set
145
146#Method ##
147
148#Struct SkIPoint16 ##
149
150#Topic IPoint16 ##