简体中文

English

简体中文

English

外观

3.2 Display 模块 API 手册 ​

该模块自固件版本 V0.7 起有显著更改，若您使用的是 V0.7 之前的固件，请参考旧版本文档。

1. 概述 ​

本手册旨在指导开发人员使用 Micro Python API 调用 CanMV Display 模块，实现图像显示功能。

如需增加自定义屏幕，可参考Display Debugger

2. API 介绍 ​

2.1 init ​

描述

初始化 Display 通路，包括 VO 模块、 DSI 模块和 LCD/HDMI。
必须在 MediaManager.init()之前调用

语法

python
init(type=None, width=None, height=None, osd_num=1, to_ide=False, fps=None, quality=90)

参数

参数名称描述输入 / 输出说明
type显示设备类型输入必选
width分辨率宽度输入默认值根据 type 决定
height分辨率高度输入默认值根据 type 决定
osd_num在 show_image 时支持的 LAYER 数量输入越大占用内存越多
to_ide是否将屏幕显示传输到 IDE 显示输入开启时占用更多内存
fps显示帧率输入仅支持 VIRT 类型
quality设置 Jpeg 压缩质量输入仅在 to_ide=True 时有效，范围 [10-100]

返回值

返回值描述
无

2.2 show_image ​

描述

在屏幕上显示图像。

语法

python
show_image(img, x=0, y=0, layer=None, alpha=255, flag=0)

参数

参数名称描述输入 / 输出说明
img显示的图像输入
x起始坐标的 x 值输入
y起始坐标的 y 值输入
layer显示到 指定层输入仅支持 OSD 层，若需要多层请在 init 中设置 osd_num
alpha图层混合 alpha输入
flag显示 标志输入

返回值

返回值描述
无

2.3 deinit ​

描述

执行反初始化， deinit 方法会关闭整个 Display 通路，包括 VO 模块、 DSI 模块和 LCD/HDMI。
必须在 MediaManager.deinit()之前调用
必须在 sensor.stop()之后调用

语法

python
deinit()

返回值

返回值描述
无

2.4 bind_layer ​

描述

将 sensor 或 vdec 模块的输出绑定到屏幕显示。无需用户手动干预即可持续显示图像。
必须在 init 之前调用

语法

python
bind_layer(src=(mod, dev, layer), dstlayer, rect=(x, y, w, h), pix_format, alpha, flag)

参数

参数名称描述输入 / 输出说明
srcsensor 或 vdec 的输出信息输入可通过 sensor.bind_info() 获取
dstlayer绑定到 Display 的 显示层输入可绑定到 video 或 osd 层
rect显示区域输入可通过 sensor.bind_info() 获取
pix_format图像像素格式输入可通过 sensor.bind_info() 获取
alpha图层混合 alpha输入
flag显示 标志输入LAYER_VIDEO1 不支持

返回值

返回值描述
无

3. 数据结构描述 ​

3.1 type ​

类型分辨率
(width x height @ fps)		备注
LT96111920x1080@30默认值
1280x720@30
640x480@60
HX83771080x1920@30默认值
ST7701800x480@30默认值
可设置为竖屏 480x800
854x480@30可设置为竖屏 480x854
VIRT640x480@90默认值
IDE 调试专用，不在外接屏幕上显示内容
用户可自定义设置分辨率 (64x64)-(4096x4096) 和帧率 (1-200)

3.2 layer ​

K230 提供 2 层视频图层支持和 4 层 OSD 图层支持。分列如下：

显示层说明备注
LAYER_VIDEO1仅可在 bind_layer 中使用
LAYER_VIDEO2仅可在 bind_layer 中使用
LAYER_OSD0支持 show_image 和 bind_layer 使用
LAYER_OSD1支持 show_image 和 bind_layer 使用
LAYER_OSD2支持 show_image 和 bind_layer 使用
LAYER_OSD3支持 show_image 和 bind_layer 使用

3.3 flag ​

标志说明备注
FLAG_ROTATION_0旋转 0 度
FLAG_ROTATION_90旋转 90 度
FLAG_ROTATION_180旋转 180 度
FLAG_ROTATION_270旋转 270 度
FLAG_MIRROR_NONE不镜像
FLAG_MIRROR_HOR水平镜像
FLAG_MIRROR_VER垂直镜像
FLAG_MIRROR_BOTH水平与垂直镜像

4. 示例程序 ​

以下为示例程序：

python
from media.display import *  # 导入 display 模块，使用 display 相关接口
from media.media import *    # 导入 media 模块，使用 media 相关接口
import os, time, image       # 导入 image 模块，使用 image 相关接口

# 使用 LCD 作为显示输出
Display.init(Display.ST7701, width=800, height=480, to_ide=True)
# 初始化媒体管理器
MediaManager.init()

# 创建用于绘图的图像
img = image.Image(800, 480, image.RGB565)
img.clear()
img.draw_string_advanced(0, 0, 32, "Hello World!，你好世界！！！", color=(255, 0, 0))

Display.show_image(img)

try:
    while True:
        time.sleep(1)
        os.exitpoint()
except KeyboardInterrupt as e:
    print(" 用户停止：", e)
except BaseException as e:
    print(f" 异常：{e}")

Display.deinit()
MediaManager.deinit()