awtk/docs/manual/rect_t.md
2019-11-15 11:15:42 +08:00

3.4 KiB
Raw Blame History

rect_t

概述

矩形。包括一个x坐标、y坐标、宽度和高度。


函数

函数名称 说明
rect_cast 转换为rect对象。
rect_create 创建rect对象。
rect_destroy 销毁rect对象。
rect_set 设置rect对象的xywh。

属性

属性名称 类型 说明
h wh_t 高度。
w wh_t 宽度。
x xy_t x坐标。
y xy_t y坐标。

rect_cast 函数


  • 函数功能:

转换为rect对象。

供脚本语言使用。

  • 函数原型:
rect_t* rect_cast (rect_t* rect);
  • 参数说明:
参数 类型 说明
返回值 rect_t* rect对象。
rect rect_t* rect对象。

rect_create 函数


  • 函数功能:

创建rect对象。

主要供脚本语言使用。

  • 函数原型:
rect_t* rect_create (xy_t x, xy_t y, wh_t w, wh_t h);
  • 参数说明:
参数 类型 说明
返回值 rect_t* rect对象。
x xy_t x坐标。
y xy_t y坐标。
w wh_t 宽度。
h wh_t 高度。

rect_destroy 函数


  • 函数功能:

销毁rect对象。

主要供脚本语言使用。

  • 函数原型:
ret_t rect_destroy (rect_t* r);
  • 参数说明:
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功否则表示失败。
r rect_t* rect对象。

rect_set 函数


  • 函数功能:

设置rect对象的xywh。

主要供脚本语言使用。

  • 函数原型:
rect_t* rect_set (rect_t* rect, xy_t x, xy_t y, wh_t w, wh_t h);
  • 参数说明:
参数 类型 说明
返回值 rect_t* rect对象。
rect rect_t* rect对象。
x xy_t x坐标。
y xy_t y坐标。
w wh_t 宽度。
h wh_t 高度。

h 属性


高度。

  • 类型wh_t
特性 是否支持
可直接读取
可直接修改
可脚本化

w 属性


宽度。

  • 类型wh_t
特性 是否支持
可直接读取
可直接修改
可脚本化

x 属性


x坐标。

  • 类型xy_t
特性 是否支持
可直接读取
可直接修改
可脚本化

y 属性


y坐标。

  • 类型xy_t
特性 是否支持
可直接读取
可直接修改
可脚本化