LayerFuncs
概述
显示图层驱动接口结构体,定义显示图层驱动接口函数指针。
相关模块:
汇总
Public 属性
名称 | 描述 |
---|---|
(InitDisplay)(uint32_t devId) | 初始化显示设备。 |
(DeinitDisplay)(uint32_t devId) | 取消初始化显示设备。 |
(GetDisplayInfo)(uint32_t devId, DisplayInfo *dispInfo) | 获取显示设备相关信息。 |
(CreateLayer)(uint32_t devId, const LayerInfo *layerInfo, uint32_t *layerId) | 打开图层。 |
(CloseLayer)(uint32_t devId, uint32_t layerId) | 关闭图层。 |
(SetLayerVisible)(uint32_t devId, uint32_t layerId, bool visible) | 设置图层是否可见。 |
(GetLayerVisibleState)(uint32_t devId, uint32_t layerId, bool *visible) | 获取图层是否可见状态。 |
(SetLayerSize)(uint32_t devId, uint32_t layerId, IRect *rect) | 设置图层大小。 |
(GetLayerSize)(uint32_t devId, uint32_t layerId, IRect *rect) | 获取图层大小。 |
(SetLayerCrop)(uint32_t devId, uint32_t layerId, IRect *rect) | 设置图层裁剪区域。 |
(SetLayerZorder)(uint32_t devId, uint32_t layerId, uint32_t zorder) | 设置图层Z轴次序。 |
(GetLayerZorder)(uint32_t devId, uint32_t layerId, uint32_t *zorder) | 获取图层Z轴次序。 |
(SetLayerPreMulti)(uint32_t devId, uint32_t layerId, bool preMul) | 设置图层预乘。 |
(GetLayerPreMulti)(uint32_t devId, uint32_t layerId, bool *preMul) | 获取图层预乘标识。 |
(SetLayerAlpha)(uint32_t devId, uint32_t layerId, LayerAlpha *alpha) | 设置图层Alpha值。 |
(GetLayerAlpha)(uint32_t devId, uint32_t layerId, LayerAlpha *alpha) | 获取图层Alpha值。 |
(SetLayerColorKey)(uint32_t devId, uint32_t layerId, bool enable, uint32_t key) | 设置图层colorkey属性,在图层叠加时使用。 |
(GetLayerColorKey)(uint32_t devId, uint32_t layerId, bool *enable, uint32_t *key) | 获取图层colorkey。 |
(SetLayerPalette)(uint32_t devId, uint32_t layerId, uint32_t *palette, uint32_t len) | 设置图层调色板。 |
(GetLayerPalette)(uint32_t devId, uint32_t layerId, uint32_t *palette, uint32_t len) | 获取图层调色板。 |
(SetTransformMode)(uint32_t devId, uint32_t layerId, TransformType type) | 设置图层变换模式,根据不同的场景设置图层的旋转、缩放、移位等。 |
(SetLayerCompression)(uint32_t devId, uint32_t layerId, int32_t compType) | 设置图层压缩功能。 |
(GetLayerCompression)(uint32_t devId, uint32_t layerId, int32_t *compType) | 获取图层压缩功能是否打开。 |
(SetLayerDirtyRegion)(uint32_t devId, uint32_t layerId, IRect *region) | 设置图层刷新区域。 |
(GetLayerBuffer)(uint32_t devId, uint32_t layerId, LayerBuffer *buffer) | 获取图层的buffer。 |
(Flush)(uint32_t devId, uint32_t layerId, LayerBuffer *buffer) | 刷新图层。 |
(WaitForVBlank)(uint32_t devId, uint32_t layerId, int32_t timeOut) | 实现等待帧消隐期到来功能。 |
(SnapShot)(uint32_t devId, LayerBuffer *buffer) | 实现抓图功能。 |
(SetLayerVisibleRegion)(uint32_t devId, uint32_t layerId, uint32_t num, IRect *rect) | 设置一个图层的可见区域。 |
(SetLayerBuffer)(uint32_t devId, uint32_t layerId, const BufferHandle *buffer, int32_t fence) | 设置一个层的缓冲区。 |
(InvokeLayerCmd)(uint32_t devId, uint32_t layerId, uint32_t cmd,...) | 扩展接口。 |
(SetLayerCompositionType)(uint32_t devId, uint32_t layerId, CompositionType type) | 设置客户端期望的组合类型。 |
(SetLayerBlendType)(uint32_t devId, uint32_t layerId, BlendType type) | 设置混合类型。 |
(SetLayerColorTransform)(uint32_t devId, uint32_t layerId, const float *matrix) | 设置图层当前的颜色转换矩阵。 |
(SetLayerColorDataSpace)(uint32_t devId, uint32_t layerId, ColorDataSpace colorSpace) | 设置图层的颜色数据空间。 |
(GetLayerColorDataSpace)(uint32_t devId, uint32_t layerId, ColorDataSpace *colorSpace) | 获取图层当前的颜色数据空间。 |
(SetLayerMetaData)(uint32_t devId, uint32_t layerId, uint32_t num, const HDRMetaData *metaData) | 设置图层的HDRmetaData。 |
(SetLayerMetaDataSet)(uint32_t devId, uint32_t layerId, HDRMetadataKey key, uint32_t num, const uint8_t *metaData) | 设置图层的metaData set。 |
(GetSupportedPresentTimestamp)(uint32_t devId, uint32_t layerId, PresentTimestampType *type) | 获取图层支持的上屏时间戳类型。 |
(GetHwPresentTimestamp)(uint32_t devId, uint32_t layerId, PresentTimestamp *pts) | 获取图层的上屏时间戳信息。 |
(SetLayerTunnelHandle)(uint32_t devId, uint32_t layerId, ExtDataHandle *handle) | 设置图层的tunnel句柄。 |
(GetLayerReleaseFence)(uint32_t devId, uint32_t layerId, int32_t *fence) | 获取图层的同步栅栏。 |
类成员变量说明
CloseLayer
int32_t(* LayerFuncs::CloseLayer) (uint32_t devId, uint32_t layerId)
描述:
关闭图层。
在完成显示后,如果不在需要使用图层,调用关闭图层接口关闭图层。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
CreateLayer
int32_t(* LayerFuncs::CreateLayer) (uint32_t devId, const LayerInfo *layerInfo, uint32_t *layerId)
描述:
打开图层。
GUI在使用图层时,需要先根据图层信息打开图层,打开图层成功可获得图层ID,根据图层ID使用图层各接口。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerInfo | 输入参数,图层信息,上层GUI打开图层时需传递图层信息,包括图层类型,图层大小,像素格式等信息。 |
layerId | 输入参数,图层ID,打开图层成功后返回给GUI的图层ID,用于标识唯一的图层。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
DeinitDisplay
int32_t(* LayerFuncs::DeinitDisplay) (uint32_t devId)
描述:
取消初始化显示设备。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
Flush
int32_t(* LayerFuncs::Flush) (uint32_t devId, uint32_t layerId, LayerBuffer *buffer)
描述:
刷新图层。
将buffer显示数据刷新到指定的layerId图层上,实现图像数据显示到屏幕上。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
buffer | 输出参数,待刷新的buffer。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
GetDisplayInfo
int32_t(* LayerFuncs::GetDisplayInfo) (uint32_t devId, DisplayInfo *dispInfo)
描述:
获取显示设备相关信息。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
dispInfo | 输出参数,显示相关信息。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
GetHwPresentTimestamp
int32_t(* LayerFuncs::GetHwPresentTimestamp) (uint32_t devId, uint32_t layerId, PresentTimestamp *pts)
描述:
获取图层的上屏时间戳信息。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,指示需要操作的设备ID。 |
layerId | 输入参数,指示需要操作的图层ID。 |
pts | 输出参数,保存图层的上屏时间戳信息, 由接口实现层进行写入。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
GetLayerAlpha
int32_t(* LayerFuncs::GetLayerAlpha) (uint32_t devId, uint32_t layerId, LayerAlpha *alpha)
描述:
获取图层alpha值。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
alpha | 输出参数,保存获取的图层alpha值。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
GetLayerBuffer
int32_t(* LayerFuncs::GetLayerBuffer) (uint32_t devId, uint32_t layerId, LayerBuffer *buffer)
描述:
获取图层的buffer。
向buffer中绘图后,调用Flush接口显示到屏幕上。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
buffer | 输出参数,保存获取的图层buffer。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
GetLayerColorDataSpace
int32_t(* LayerFuncs::GetLayerColorDataSpace) (uint32_t devId, uint32_t layerId, ColorDataSpace *colorSpace)
描述:
获取图层当前的颜色数据空间。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,指示需要操作的设备ID。 |
layerId | 输入参数,指示需要操作的图层ID。 |
colorSpace | 输出参数,保存对应图层的颜色数据空间。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
GetLayerColorKey
int32_t(* LayerFuncs::GetLayerColorKey) (uint32_t devId, uint32_t layerId, bool *enable, uint32_t *key)
描述:
获取图层colorkey。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
enable | 输出参数,保存获取的enable色键使能标识。 |
key | 输出参数,保存获取的色键值,即颜色值。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
GetLayerCompression
int32_t(* LayerFuncs::GetLayerCompression) (uint32_t devId, uint32_t layerId, int32_t *compType)
描述:
获取图层压缩功能是否打开。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
compType | 输出参数,保存获取的图层压缩功能状态。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
GetLayerPalette
int32_t(* LayerFuncs::GetLayerPalette) (uint32_t devId, uint32_t layerId, uint32_t *palette, uint32_t len)
描述:
获取图层调色板。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
palette | 输出参数,保存获取的图层调色板。 |
len | 输入参数,调色板长度。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
GetLayerPreMulti
int32_t(* LayerFuncs::GetLayerPreMulti) (uint32_t devId, uint32_t layerId, bool *preMul)
描述:
获取图层预乘标识。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
preMul | 输出参数,保存获取的图层预乘使能标识。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
GetLayerReleaseFence
int32_t(* LayerFuncs::GetLayerReleaseFence) (uint32_t devId, uint32_t layerId, int32_t *fence)
描述:
获取图层的同步栅栏。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,指示需要操作的设备ID。 |
layerId | 输入参数,指示需要操作的图层ID。 |
fence | 输出参数,保存图层的 release fence, 由接口实现层进行写入。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
GetLayerSize
int32_t(* LayerFuncs::GetLayerSize) (uint32_t devId, uint32_t layerId, IRect *rect)
描述:
获取图层大小。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
rect | 输出参数,保存获取的图层大小。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
GetLayerVisibleState
int32_t(* LayerFuncs::GetLayerVisibleState) (uint32_t devId, uint32_t layerId, bool *visible)
描述:
获取图层是否可见状态。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
visible | 输出参数,保存获取的图层可见状态,true表示图层可见,false表示图层不可见。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
GetLayerZorder
int32_t(* LayerFuncs::GetLayerZorder) (uint32_t devId, uint32_t layerId, uint32_t *zorder)
描述:
获取图层Z轴次序。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
zorder | 输出参数,保存获取的图层Z轴次序,为整数值,取值范围为[0, 255],值越大图层越往上排列。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
GetSupportedPresentTimestamp
int32_t(* LayerFuncs::GetSupportedPresentTimestamp) (uint32_t devId, uint32_t layerId, PresentTimestampType *type)
描述:
获取图层支持的上屏时间戳类型。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,指示需要操作的设备ID。 |
layerId | 输入参数,指示需要操作的图层ID。 |
type | 输出参数,保存图层支持的上屏时间戳类型, 由接口实现层进行写入。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
InitDisplay
int32_t(* LayerFuncs::InitDisplay) (uint32_t devId)
描述:
初始化显示设备。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
InvokeLayerCmd
int32_t(* LayerFuncs::InvokeLayerCmd) (uint32_t devId, uint32_t layerId, uint32_t cmd,...)
描述:
扩展接口
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备的ID。取值范围为0 ~ 4,其中0表示第一个显示设备,4表示最后一个显示设备。 |
layerId | 输入参数,层ID,唯一标识一个层。可以对该层进行操作。 |
cmd | 输入参数,表示扩展cmd,用于识别不同的意图。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
SetLayerAlpha
int32_t(* LayerFuncs::SetLayerAlpha) (uint32_t devId, uint32_t layerId, LayerAlpha *alpha)
描述:
设置图层alpha值。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
alpha | 输入参数,待设置的图层 alpha 值。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
SetLayerBlendType
int32_t(* LayerFuncs::SetLayerBlendType) (uint32_t devId, uint32_t layerId, BlendType type)
描述:
设置混合类型
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备的ID。取值范围为0 ~ 4,其中0表示第一个显示设备,4表示最后一个显示设备。 |
layerId | 输入参数,层ID,唯一标识一个层。可以对该层进行操作。 |
type | 输入参数,指示混合类型。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
SetLayerBuffer
int32_t(* LayerFuncs::SetLayerBuffer) (uint32_t devId, uint32_t layerId, const BufferHandle *buffer, int32_t fence)
描述:
设置一个层的缓冲区。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备的ID。取值范围为0 ~ 4,其中0表示第一个显示设备,4表示最后一个显示设备。 |
layerId | 输入参数,层ID,唯一标识一个层。可以对该层进行操作。 |
buffer | 输入参数,指示缓冲区句柄的指针,该指针包含所有用于合成的缓冲区的所有信息。 |
fence | 输入参数,同步文件的fd。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
SetLayerColorDataSpace
int32_t(* LayerFuncs::SetLayerColorDataSpace) (uint32_t devId, uint32_t layerId, ColorDataSpace colorSpace)
描述:
设置图层的颜色数据空间。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,指示需要操作的设备ID。 |
layerId | 输入参数,指示需要操作的图层ID。 |
colorSpace | 输入参数,表示需要设置的颜色数据空间。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
SetLayerColorKey
int32_t(* LayerFuncs::SetLayerColorKey) (uint32_t devId, uint32_t layerId, bool enable, uint32_t key)
描述:
设置图层colorkey属性,在图层叠加时使用。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
enable | 输入参数,待设置的色键使能标识。 |
key | 输入参数,待设置的色键值,即颜色值。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
SetLayerColorTransform
int32_t(* LayerFuncs::SetLayerColorTransform) (uint32_t devId, uint32_t layerId, const float *matrix)
描述:
设置图层当前的颜色转换矩阵。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,指示需要操作的设备ID。 |
layerId | 输入参数,指示需要操作的图层ID。 |
matrix | 输入参数,表示需要设置的颜色转换模式。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
SetLayerCompositionType
int32_t(* LayerFuncs::SetLayerCompositionType) (uint32_t devId, uint32_t layerId, CompositionType type)
描述:
设置客户端期望的组合类型。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备的ID。取值范围为0 ~ 4,其中0表示第一个显示设备,4表示最后一个显示设备。 |
layerId | 输入参数,层ID,唯一标识一个层。可以对该层进行操作。 |
type | 输入参数,指示客户端期望的组合类型。它可能随实现而变化。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
SetLayerCompression
int32_t(* LayerFuncs::SetLayerCompression) (uint32_t devId, uint32_t layerId, int32_t compType)
描述:
设置图层压缩功能。
在特定场景下,需要对图像数据进行压缩,可设置启动或关闭图层压缩功能。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
compType | 输入参数,图层压缩使能标识。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
SetLayerCrop
int32_t(* LayerFuncs::SetLayerCrop) (uint32_t devId, uint32_t layerId, IRect *rect)
描述:
设置图层裁剪区域。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
rect | 输入参数,待设置的裁剪区域。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
SetLayerDirtyRegion
int32_t(* LayerFuncs::SetLayerDirtyRegion) (uint32_t devId, uint32_t layerId, IRect *region)
描述:
设置图层刷新区域。
GUI图形系统绘制好图像数据后,在调用Flush接口刷新屏幕之前需要设置图层刷新区域。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
region | 输入参数,待设置的刷新区域。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
SetLayerMetaData
int32_t(* LayerFuncs::SetLayerMetaData) (uint32_t devId, uint32_t layerId, uint32_t num, const HDRMetaData *metaData)
描述:
设置图层的HDRmetaData。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,指示需要操作的设备ID。 |
layerId | 输入参数,指示需要操作的图层ID。 |
num | 输入参数,metadata 数组个数。 |
metaData | 输入参数,表示需要设置的 metadata 数组首地址。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
SetLayerMetaDataSet
int32_t(* LayerFuncs::SetLayerMetaDataSet) (uint32_t devId, uint32_t layerId, HDRMetadataKey key, uint32_t num, const uint8_t *metaData)
描述:
设置图层的metaData set。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,指示需要操作的设备ID。 |
layerId | 输入参数,指示需要操作的图层ID。 |
key | 输入参数,表示需要设置的HDRMetadataKey。 |
num | 输入参数,metadata 数组个数。 |
metaData | 输入参数,表示需要设置的 metadata 数组首地址, 数据类型为uint8_t。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
SetLayerPalette
int32_t(* LayerFuncs::SetLayerPalette) (uint32_t devId, uint32_t layerId, uint32_t *palette, uint32_t len)
描述:
设置图层调色板。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
palette | 输入参数,待设置的图层调色板。 |
len | 输入参数,调色板长度。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
SetLayerPreMulti
int32_t(* LayerFuncs::SetLayerPreMulti) (uint32_t devId, uint32_t layerId, bool preMul)
描述:
设置图层预乘。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
preMul | 输入参数,待设置的图层预乘使能标识,1表示使能图层预乘,0表示不使能图层预乘。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
SetLayerSize
int32_t(* LayerFuncs::SetLayerSize) (uint32_t devId, uint32_t layerId, IRect *rect)
描述:
设置图层大小。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
rect | 输入参数,待设置的图层大小,单位为像素。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
SetLayerTunnelHandle
int32_t(* LayerFuncs::SetLayerTunnelHandle) (uint32_t devId, uint32_t layerId, ExtDataHandle *handle)
描述:
设置图层的tunnel句柄。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,指示需要操作的设备ID。 |
layerId | 输入参数,指示需要操作的图层ID。 |
handle | 输入参数,表示需要设置的句柄。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
SetLayerVisible
int32_t(* LayerFuncs::SetLayerVisible) (uint32_t devId, uint32_t layerId, bool visible)
描述:
设置图层是否可见。
不可见情况下图层不显示在屏幕上,可见情况下图层显示在屏幕上。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
visible | 输入参数,待设置的图层可见标识,设置true表示图层可见,设置false表示图层不可见。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
SetLayerVisibleRegion
int32_t(* LayerFuncs::SetLayerVisibleRegion) (uint32_t devId, uint32_t layerId, uint32_t num, IRect *rect)
描述:
设置一个图层的可见区域
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备的ID。取值范围为0 ~ 4,其中0表示第一个显示设备,4表示最后一个显示设备。 |
layerId | 输入参数,层ID,唯一标识一个层。可以对该层进行操作。 |
num | 输入参数,指定rect的计数,该区域包含多个IRect,num表示该区域中有多少个rect区域。 |
rect | 输出参数,rectes对象的指针。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
SetLayerZorder
int32_t(* LayerFuncs::SetLayerZorder) (uint32_t devId, uint32_t layerId, uint32_t zorder)
描述:
设置图层Z轴次序。
图层的Z序值越大,图层越靠上显示。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
zorder | 输入参数,待设置的图层Z序,为整数值,取值范围为[0, 255],值越大图层越往上排列。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
参见:
SetTransformMode
int32_t(* LayerFuncs::SetTransformMode) (uint32_t devId, uint32_t layerId, TransformType type)
描述:
设置图层变换模式,根据不同的场景设置图层的旋转、缩放、移位等。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
type | 输入参数,待设置的图层变换模式。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
SnapShot
int32_t(* LayerFuncs::SnapShot) (uint32_t devId, LayerBuffer *buffer)
描述:
实现抓图功能。
本函数将显示设备上的图像数据截图保存到buffer中,用于调试、应用截图等场景。
otherwise.
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
buffer | 输出参数,保存截屏的buffer信息。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。
WaitForVBlank
int32_t(* LayerFuncs::WaitForVBlank) (uint32_t devId, uint32_t layerId, int32_t timeOut)
描述:
实现等待帧消隐期到来功能。
该函数会让系统等待,直到帧消隐期到来,用于软件和硬件之间的同步。
参数:
名称 | 描述 |
---|---|
devId | 输入参数,显示设备ID,用于支持多个显示设备,取值从0开始,0表示第一个设备,最大支持5个设备。 |
layerId | 输入参数,图层ID,图层的唯一标识,根据图层ID操作图层。 |
timeOut | 输入参数,超时时间,在设置的超时时间后,没有等到帧消隐期到来则超时返回。 |
返回:
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败,具体错误码查看DispErrCode。