awtk/docs/manual/mutable_image_t.md

mutable_image_t

概述

mutable图片控件。

像摄像头和视频的图像是变化的，每一帧都不同，我们把这类图片称为mutable image。

本控件辅助实现摄像头和视频的显示功能。

mutable_image_t是image_base_t的子类控件，image_base_t的函数均适用于mutable_image_t控件。

在xml中使用"mutable_image"标签创建mutable图片控件。如：

<mutable_image w="100%" h="100%"/>

更多用法请参考： mutable image

在c代码中使用函数mutable_image_create创建mutable图片控件。如：

widget_t* image = mutable_image_create(win, 10, 10, 200, 200);
mutable_image_set_prepare_image(image, get_camera_image, camera);

创建之后:

需要用mutable_image_set_create_image设置创建图片的回调函数。 需要用mutable_image_set_prepare_image设置准备图片的回调函数。

完整示例请参考：mutable image demo

一般不需通过style来设置控件的显示风格，如果在特殊情况下需要，可以参考其它控件。

函数

函数名称	说明
mutable_image_cast	转换为mutable_image对象(供脚本语言使用)。
mutable_image_create	创建mutable_image对象
mutable_image_get_widget_vtable	获取 mutable_image 虚表。
mutable_image_init	初始化 mutable_image （提供给继承的子类使用的）
mutable_image_on_destroy	释放 mutable_image （提供给继承的子类使用的）
mutable_image_on_paint_self	mutable_image 的绘制函数 （提供给继承的子类使用的）
mutable_image_set_create_image	设置create_image回调函数。
mutable_image_set_framebuffer	设置framebuffer(当硬件支持多层合成时才用)。
mutable_image_set_need_redraw	设置need_redraw回调函数。
mutable_image_set_prepare_image	设置prepare_image回调函数。

mutable_image_cast 函数

---

• 函数功能：

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

• 函数原型：

widget_t* mutable_image_cast (widget_t* widget);

• 参数说明：

参数	类型	说明
返回值	widget_t*	mutable_image对象。
widget	widget_t*	mutable_image对象。

mutable_image_create 函数

---

• 函数功能：

创建mutable_image对象

• 函数原型：

widget_t* mutable_image_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);

• 参数说明：

参数	类型	说明
返回值	widget_t*	对象。
parent	widget_t*	父控件
x	xy_t	x坐标
y	xy_t	y坐标
w	wh_t	宽度
h	wh_t	高度

mutable_image_get_widget_vtable 函数

---

• 函数功能：

获取 mutable_image 虚表。

• 函数原型：

const widget_vtable_t* mutable_image_get_widget_vtable ();

• 参数说明：

参数	类型	说明
返回值	const widget_vtable_t*	成功返回 mutable_image 虚表。

mutable_image_init 函数

---

• 函数功能：

初始化 mutable_image （提供给继承的子类使用的）

• 函数原型：

widget_t* mutable_image_init (widget_t* widget);

• 参数说明：

参数	类型	说明
返回值	widget_t*	mutable_image对象。
widget	widget_t*	mutable_image对象。

mutable_image_on_destroy 函数

---

• 函数功能：

释放 mutable_image （提供给继承的子类使用的）

• 函数原型：

ret_t mutable_image_on_destroy (widget_t* widget);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	mutable_image对象。

mutable_image_on_paint_self 函数

---

• 函数功能：

mutable_image 的绘制函数 （提供给继承的子类使用的）

• 函数原型：

ret_t mutable_image_on_paint_self (widget_t* widget, canvas_t* canvas);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	mutable_image对象。
canvas	canvas_t*	画布对象。

mutable_image_set_create_image 函数

---

• 函数功能：

设置create_image回调函数。

• 函数原型：

ret_t mutable_image_set_create_image (widget_t* widget, mutable_image_create_image_t create_image, void* create_image_ctx);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	mutable_image对象。
create_image	mutable_image_create_image_t	创建图片的回调函数。
create_image_ctx	void*	create_image回调函数的上下文。

mutable_image_set_framebuffer 函数

---

• 函数功能：

设置framebuffer(当硬件支持多层合成时才用)。

有的硬件支持多层framebuffer，一层用于视图/摄像头，一层用于GUI，由硬件合成最终图像。 此时可以设置用于摄像头的framebuffer，图像直接绘制到该framebuffer上。

• 函数原型：

ret_t mutable_image_set_framebuffer (widget_t* widget, uint32_t w, uint32_t h, bitmap_format_t format, uint8_t* buff);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	mutable_image对象。
w	uint32_t	framebuffer宽度。
h	uint32_t	framebuffer高度。
format	bitmap_format_t	framebuffer的格式。
buff	uint8_t*	framebuffer内存。

mutable_image_set_need_redraw 函数

---

• 函数功能：

设置need_redraw回调函数。

缺省每16ms刷新一次。但有时只是在变化时刷新，所以提供一个回调函数由用户决定是否需要重绘。

• 函数原型：

ret_t mutable_image_set_need_redraw (widget_t* widget, mutable_image_need_redraw_t need_redraw, void* need_redraw_ctx);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	mutable_image对象。
need_redraw	mutable_image_need_redraw_t	检查是否需要重绘的回调函数。
need_redraw_ctx	void*	need_redraw回调函数的上下文。

mutable_image_set_prepare_image 函数

---

• 函数功能：

设置prepare_image回调函数。

prepare_image回调函数在每次绘制之前被调用，用于准备下一帧要显示的图片。 比如获取摄像头的预览图片，将其设置到image参数中。

注意：在回调函数中，只能修改图片的内容，不用修改图片的大小和格式，如果不匹配请先转换。

• 函数原型：

ret_t mutable_image_set_prepare_image (widget_t* widget, mutable_image_prepare_image_t prepare_image, void* prepare_image_ctx);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
widget	widget_t*	mutable_image对象。
prepare_image	mutable_image_prepare_image_t	准备图片的回调函数。
prepare_image_ctx	void*	prepare_image回调函数的上下文。