• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# drawing_point.h
2
3## 概述
4
5文件中定义了与坐标点相关的功能函数。
6
7**引用文件:** <native_drawing/drawing_point.h>
8
9**库:** libnative_drawing.so
10
11**起始版本:** 11
12
13**相关模块:** [Drawing](capi-drawing.md)
14
15## 汇总
16
17### 函数
18
19| 名称 | 描述 |
20| -- | -- |
21| [OH_Drawing_Point* OH_Drawing_PointCreate(float x, float y)](#oh_drawing_pointcreate) | 用于创建一个坐标点对象。 |
22| [OH_Drawing_ErrorCode OH_Drawing_PointGetX(const OH_Drawing_Point* point, float* x)](#oh_drawing_pointgetx) | 用于获取点的x轴坐标。 |
23| [OH_Drawing_ErrorCode OH_Drawing_PointGetY(const OH_Drawing_Point* point, float* y)](#oh_drawing_pointgety) | 用于获取点的y轴坐标。 |
24| [OH_Drawing_ErrorCode OH_Drawing_PointSet(OH_Drawing_Point* point, float x, float y)](#oh_drawing_pointset) | 用于设置点的x轴和y轴坐标。 |
25| [void OH_Drawing_PointDestroy(OH_Drawing_Point* point)](#oh_drawing_pointdestroy) | 用于销毁坐标点对象并回收该对象占有的内存。 |
26
27## 函数说明
28
29### OH_Drawing_PointCreate()
30
31```
32OH_Drawing_Point* OH_Drawing_PointCreate(float x, float y)
33```
34
35**描述**
36
37用于创建一个坐标点对象。
38
39**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
40
41**起始版本:** 11
42
43
44**参数:**
45
46| 参数项 | 描述 |
47| -- | -- |
48| float x | X轴坐标。 |
49| float y | Y轴坐标。 |
50
51**返回:**
52
53| 类型 | 说明 |
54| -- | -- |
55| [OH_Drawing_Point](capi-drawing-oh-drawing-point.md)* | 函数会返回一个指针,指针指向创建的坐标点对象。 |
56
57### OH_Drawing_PointGetX()
58
59```
60OH_Drawing_ErrorCode OH_Drawing_PointGetX(const OH_Drawing_Point* point, float* x)
61```
62
63**描述**
64
65用于获取点的x轴坐标。
66
67**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
68
69**起始版本:** 12
70
71
72**参数:**
73
74| 参数项 | 描述 |
75| -- | -- |
76| const [OH_Drawing_Point](capi-drawing-oh-drawing-point.md)* point | 指向坐标点对象[OH_Drawing_Point](capi-drawing-oh-drawing-point.md)的指针。 |
77| float* x | 表示点的x轴坐标。 |
78
79**返回:**
80
81| 类型 | 说明 |
82| -- | -- |
83| [OH_Drawing_ErrorCode](capi-drawing-error-code-h.md#oh_drawing_errorcode) | 函数返回执行错误码。<br> 返回OH_DRAWING_SUCCESS,表示执行成功。<br> 返回OH_DRAWING_ERROR_INVALID_PARAMETER,表示参数point或者x为空。 |
84
85### OH_Drawing_PointGetY()
86
87```
88OH_Drawing_ErrorCode OH_Drawing_PointGetY(const OH_Drawing_Point* point, float* y)
89```
90
91**描述**
92
93用于获取点的y轴坐标。
94
95**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
96
97**起始版本:** 12
98
99
100**参数:**
101
102| 参数项 | 描述 |
103| -- | -- |
104| const [OH_Drawing_Point](capi-drawing-oh-drawing-point.md)* point | 指向坐标点对象[OH_Drawing_Point](capi-drawing-oh-drawing-point.md)的指针。 |
105| float* y | 表示点的y轴坐标。 |
106
107**返回:**
108
109| 类型 | 说明 |
110| -- | -- |
111| [OH_Drawing_ErrorCode](capi-drawing-error-code-h.md#oh_drawing_errorcode) | 函数返回执行错误码。<br> 返回OH_DRAWING_SUCCESS,表示执行成功。<br> 返回OH_DRAWING_ERROR_INVALID_PARAMETER,表示参数point或者y为空。 |
112
113### OH_Drawing_PointSet()
114
115```
116OH_Drawing_ErrorCode OH_Drawing_PointSet(OH_Drawing_Point* point, float x, float y)
117```
118
119**描述**
120
121用于设置点的x轴和y轴坐标。
122
123**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
124
125**起始版本:** 12
126
127
128**参数:**
129
130| 参数项 | 描述 |
131| -- | -- |
132| [OH_Drawing_Point](capi-drawing-oh-drawing-point.md)* point | 指向坐标点对象[OH_Drawing_Point](capi-drawing-oh-drawing-point.md)的指针。 |
133| float x | 表示点的x轴坐标。 |
134| float y | 表示点的y轴坐标。 |
135
136**返回:**
137
138| 类型 | 说明 |
139| -- | -- |
140| [OH_Drawing_ErrorCode](capi-drawing-error-code-h.md#oh_drawing_errorcode) | 函数返回执行错误码。<br> 返回OH_DRAWING_SUCCESS,表示执行成功。<br> 返回OH_DRAWING_ERROR_INVALID_PARAMETER,表示参数point为空。 |
141
142### OH_Drawing_PointDestroy()
143
144```
145void OH_Drawing_PointDestroy(OH_Drawing_Point* point)
146```
147
148**描述**
149
150用于销毁坐标点对象并回收该对象占有的内存。
151
152**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
153
154**起始版本:** 11
155
156
157**参数:**
158
159| 参数项 | 描述 |
160| -- | -- |
161| [OH_Drawing_Point](capi-drawing-oh-drawing-point.md)* point | 指向坐标点对象的指针。 |
162
163
164