canvas_t

概述

canvas类。

函数

函数名称 说明
canvas_cast 转换为canvas对象(供脚本语言使用)。
canvas_draw_hline 画水平线。
canvas_draw_icon 绘制图标。
canvas_draw_image 绘制图片。
canvas_draw_points 画多个点。
canvas_draw_text 绘制文本。
canvas_draw_text_in_rect 绘制文本。
canvas_draw_utf8 绘制文本。
canvas_draw_utf8_in_rect 绘制文本。
canvas_draw_vline 画垂直线。
canvas_fill_rect 填充矩形。
canvas_get_clip_rect 获取裁剪区。
canvas_get_height 获取画布的高度。
canvas_get_vgcanvas 获取vgcanvas对象。
canvas_get_width 获取画布的宽度。
canvas_init 初始化，系统内部调用。
canvas_measure_text 计算文本所占的宽度。
canvas_measure_utf8 计算文本所占的宽度。
canvas_set_clip_rect 设置裁剪区。
canvas_set_clip_rect_ex 设置裁剪区。
canvas_set_fill_color 设置填充颜色。
canvas_set_fill_color_str 设置填充颜色。
canvas_set_font 设置字体。
canvas_set_global_alpha 设置全局alpha值。
canvas_set_stroke_color 设置线条颜色。
canvas_set_stroke_color_str 设置线条颜色。
canvas_set_text_align 设置文本对齐方式。
canvas_set_text_color 设置文本颜色。
canvas_set_text_color_str 设置文本颜色。
canvas_stroke_rect 绘制矩形。
canvas_translate 平移原点坐标。
canvas_untranslate 反向平移原点坐标。

属性

属性名称 类型 说明
ox xy_t x坐标偏移。
oy xy_t y坐标偏移。

canvas_cast 函数

  • 函数功能：

转换为canvas对象(供脚本语言使用)。

  • 函数原型：
  1. canvas_t* canvas_cast (canvas_t* c);
  • 参数说明：
参数 类型 说明
返回值 canvas_t* canvas对象。
c canvas_t* canvas对象。

canvas_draw_hline 函数

  • 函数功能：

画水平线。

  • 函数原型：
  1. ret_t canvas_draw_hline (canvas_t* c, xy_t x, xy_t y, wh_t w);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
x xy_t x坐标。
y xy_t y坐标。
w wh_t 宽度。

canvas_draw_icon 函数

  • 函数功能：

绘制图标。

  • 函数原型：
  1. ret_t canvas_draw_icon (canvas_t* c, bitmap_t* img, xy_t cx, xy_t cy);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
img bitmap_t* 图片对象。
cx xy_t 中心点x坐标。
cy xy_t 中心点y坐标。

canvas_draw_image 函数

  • 函数功能：

绘制图片。

  • 函数原型：
  1. ret_t canvas_draw_image (canvas_t* c, bitmap_t* img, rect_t* src, rect_t* dst);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
img bitmap_t* 图片对象。
src rect_t* 源区域。
dst rect_t* 目的区域。

canvas_draw_points 函数

  • 函数功能：

画多个点。

  • 函数原型：
  1. ret_t canvas_draw_points (canvas_t* c, const point_t* points, uint32_t nr);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
points const point_t* 点数组。
nr uint32_t 点的个数。

canvas_draw_text 函数

  • 函数功能：

绘制文本。

  • 函数原型：
  1. ret_t canvas_draw_text (canvas_t* c, const wchar_t* str, uint32_t nr, xy_t x, xy_t y);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
str const wchar_t* 字符串。
nr uint32_t 字符数。
x xy_t x坐标。
y xy_t y坐标。

canvas_draw_text_in_rect 函数

  • 函数功能：

绘制文本。

  • 函数原型：
  1. ret_t canvas_draw_text_in_rect (canvas_t* c, const wchar_t* str, uint32_t nr, const rect_t* r);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
str const wchar_t* 字符串。
nr uint32_t 字符数。
r const rect_t* 矩形区域。

canvas_draw_utf8 函数

  • 函数功能：

绘制文本。

供脚本语言使用。

  • 函数原型：
  1. ret_t canvas_draw_utf8 (canvas_t* c, const char* str, xy_t x, xy_t y);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
str const char* 字符串。
x xy_t x坐标。
y xy_t y坐标。

canvas_draw_utf8_in_rect 函数

  • 函数功能：

绘制文本。

供脚本语言使用。

  • 函数原型：
  1. ret_t canvas_draw_utf8_in_rect (canvas_t* c, const char* str, const rect_t* r);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
str const char* 字符串。
r const rect_t* 矩形区域。

canvas_draw_vline 函数

  • 函数功能：

画垂直线。

  • 函数原型：
  1. ret_t canvas_draw_vline (canvas_t* c, xy_t x, xy_t y, wh_t h);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
x xy_t x坐标。
y xy_t y坐标。
h wh_t 高度。

canvas_fill_rect 函数

  • 函数功能：

填充矩形。

  • 函数原型：
  1. ret_t canvas_fill_rect (canvas_t* c, xy_t x, xy_t y, wh_t w, wh_t h);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
x xy_t x坐标。
y xy_t y坐标。
w wh_t 宽度。
h wh_t 高度。

canvas_get_clip_rect 函数

  • 函数功能：

获取裁剪区。

  • 函数原型：
  1. ret_t canvas_get_clip_rect (canvas_t* c, rect_t* r);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
r rect_t* rect对象。

canvas_get_height 函数

  • 函数功能：

获取画布的高度。

  • 函数原型：
  1. wh_t canvas_get_height (canvas_t* c);
  • 参数说明：
参数 类型 说明
返回值 wh_t 返回画布的高度。
c canvas_t* canvas对象。

canvas_get_vgcanvas 函数

  • 函数功能：

获取vgcanvas对象。

  • 函数原型：
  1. vgcanvas_t* canvas_get_vgcanvas (canvas_t* c);
  • 参数说明：
参数 类型 说明
返回值 vgcanvas_t* 返回vgcanvas对象。
c canvas_t* canvas对象。

canvas_get_width 函数

  • 函数功能：

获取画布的宽度。

  • 函数原型：
  1. wh_t canvas_get_width (canvas_t* c);
  • 参数说明：
参数 类型 说明
返回值 wh_t 返回画布的宽度。
c canvas_t* canvas对象。

canvas_init 函数

  • 函数功能：

初始化，系统内部调用。

  • 函数原型：
  1. canvas_t* canvas_init (canvas_t* c, lcd_t* lcd, font_manager_t* font_manager);
  • 参数说明：
参数 类型 说明
返回值 canvas_t* 返回canvas对象本身。
c canvas_t* canvas对象。
lcd lcd_t* lcd对象。
font_manager font_manager_t* 字体管理器对象。

canvas_measure_text 函数

  • 函数功能：

计算文本所占的宽度。

  • 函数原型：
  1. float_t canvas_measure_text (canvas_t* c, const wchar_t* str, uint32_t nr);
  • 参数说明：
参数 类型 说明
返回值 float_t 返回文本所占的宽度。
c canvas_t* canvas对象。
str const wchar_t* 字符串。
nr uint32_t 字符数。

canvas_measure_utf8 函数

  • 函数功能：

计算文本所占的宽度。

供脚本语言使用。

  • 函数原型：
  1. float_t canvas_measure_utf8 (canvas_t* c, const char* str);
  • 参数说明：
参数 类型 说明
返回值 float_t 返回文本所占的宽度。
c canvas_t* canvas对象。
str const char* 字符串。

canvas_set_clip_rect 函数

  • 函数功能：

设置裁剪区。

  • 函数原型：
  1. ret_t canvas_set_clip_rect (canvas_t* c, const rect_t* r);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
r const rect_t* rect对象。

canvas_set_clip_rect_ex 函数

  • 函数功能：

设置裁剪区。

  • 函数原型：
  1. ret_t canvas_set_clip_rect_ex (canvas_t* c, const rect_t* r, bool_t translate);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
r const rect_t* rect对象。
translate bool_t 是否将裁剪区的位置加上canvas当前的偏移。

canvas_set_fill_color 函数

  • 函数功能：

设置填充颜色。

  • 函数原型：
  1. ret_t canvas_set_fill_color (canvas_t* c, color_t color);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
color color_t 颜色。

canvas_set_fill_color_str 函数

  • 函数功能：

设置填充颜色。

供脚本语言使用。

  • 函数原型：
  1. ret_t canvas_set_fill_color_str (canvas_t* c, const char* color);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
color const char* 颜色。

canvas_set_font 函数

  • 函数功能：

设置字体。

  • 函数原型：
  1. ret_t canvas_set_font (canvas_t* c, const char* name, font_size_t size);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
name const char* 字体名称。
size font_size_t 字体大小。

canvas_set_global_alpha 函数

  • 函数功能：

设置全局alpha值。

  • 函数原型：
  1. ret_t canvas_set_global_alpha (canvas_t* c, uint8_t alpha);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
alpha uint8_t alpha值。

canvas_set_stroke_color 函数

  • 函数功能：

设置线条颜色。

  • 函数原型：
  1. ret_t canvas_set_stroke_color (canvas_t* c, color_t color);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
color color_t 颜色。

canvas_set_stroke_color_str 函数

  • 函数功能：

设置线条颜色。

供脚本语言使用。

  • 函数原型：
  1. ret_t canvas_set_stroke_color_str (canvas_t* c, const char* color);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
color const char* 颜色。

canvas_set_text_align 函数

  • 函数功能：

设置文本对齐方式。

  • 函数原型：
  1. ret_t canvas_set_text_align (canvas_t* c, align_h_t align_h, align_v_t align_v);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
align_h align_h_t 水平对齐方式。
align_v align_v_t 垂直对齐方式。

canvas_set_text_color 函数

  • 函数功能：

设置文本颜色。

  • 函数原型：
  1. ret_t canvas_set_text_color (canvas_t* c, color_t color);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
color color_t 颜色。

canvas_set_text_color_str 函数

  • 函数功能：

设置文本颜色。

供脚本语言使用。

  • 函数原型：
  1. ret_t canvas_set_text_color_str (canvas_t* c, const char* color);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
color const char* 颜色。

canvas_stroke_rect 函数

  • 函数功能：

绘制矩形。

  • 函数原型：
  1. ret_t canvas_stroke_rect (canvas_t* c, xy_t x, xy_t y, wh_t w, wh_t h);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
x xy_t x坐标。
y xy_t y坐标。
w wh_t 宽度。
h wh_t 高度。

canvas_translate 函数

  • 函数功能：

平移原点坐标。

  • 函数原型：
  1. ret_t canvas_translate (canvas_t* c, xy_t dx, xy_t dy);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
dx xy_t x偏移。
dy xy_t y偏移。

canvas_untranslate 函数

  • 函数功能：

反向平移原点坐标。

  • 函数原型：
  1. ret_t canvas_untranslate (canvas_t* c, xy_t dx, xy_t dy);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
c canvas_t* canvas对象。
dx xy_t x偏移。
dy xy_t y偏移。

ox 属性

x坐标偏移。

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

oy 属性

y坐标偏移。

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