Display

概述

显示模块驱动接口定义。

提供给图形系统使用的驱动接口，包括图层管理、设备控制、图形硬件加速、显示内存管理和回调接口等。

Since:

1.0

Version:

2.0

汇总

文件

类

宏定义

类型定义

枚举

函数

变量

宏定义说明

HDI_VGU_SCALAR_IS_FLOAT

#define HDI_VGU_SCALAR_IS_FLOAT   1

PROPERTY_NAME_LEN

#define PROPERTY_NAME_LEN   50

描述:

属性名称长度

类型定义说明

HotPlugCallback

typedef void(* HotPlugCallback) (uint32_t devId, bool connected, void *data)

描述:

热插拔事件回调

当有热插拔事件发生时，会回调该接口，需要通过RegHotPlugCallback注册该回调接口。

参数:

RefreshCallback

typedef void(* RefreshCallback) (uint32_t devId, void *data)

描述:

刷新请求回调

当接口实现层需要图形服务刷新数据帧时会回调该接口，需要通过RegDisplayRefreshCallback注册该回调接口。

参数:

VBlankCallback

typedef void(* VBlankCallback) (unsigned int sequence, uint64_t ns, void *data)

描述:

VBlank 事件回调。

垂直同步事件回调接口，需要通过RegDisplayVBlankCallback注册该回调接口。

参数:

VGUBlendType

typedef BlendTypeVGUBlendType

VGUPixelFormat

typedef PixelFormatVGUPixelFormat

VGUScalar

typedef float VGUScalar

枚举类型说明

anonymous enum

anonymous enum

描述:

定义缓冲区使用。

BlendType

enum BlendType

描述:

支持的图像混合类型。

系统在硬件加速期间基于指定的混合类型合成图像。

ColorDataSpace

enum ColorDataSpace

描述:

枚举颜色空间的类型

ColorGamut

enum ColorGamut

描述:

色域类型枚举值

ColorKey

enum ColorKey

描述:

Color key操作类型定义，即硬件加速支持的Color key操作类型。

CompositionType

enum CompositionType

描述:

枚举特殊层的组合类型。

Connection

enum Connection

描述:

热插拔连接类型定义

DispErrCode

enum DispErrCode

描述:

返回值类型定义。

DispPowerStatus

enum DispPowerStatus

描述:

枚举显示状态

GamutMap

enum GamutMap

描述:

枚举色域的映射类型

HDRFormat

enum HDRFormat

描述:

枚举HDR格式

HDRMetadataKey

enum HDRMetadataKey

描述:

枚举HDR元数据关键字

InterfaceType

enum InterfaceType

描述:

枚举接口类型。

LayerType

enum LayerType

描述:

图层类型定义。

MirrorType

enum MirrorType

描述:

硬件加速支持的镜像操作类型定义

PixelFormat

enum PixelFormat

描述:

像素格式类型定义。

PresentTimestampType

enum PresentTimestampType

描述:

上屏时间戳类型枚举值

RopType

enum RopType

描述:

硬件加速支持的ROP操作类型。

在将前景位图的RGB颜色分量和Alpha分量值与背景位图的RGB颜色分量值和Alpha分量值进行按位的布尔运算（包括按位与，按位或等），将结果输出。

TransformType

enum TransformType

描述:

图层变换类型定义。

VGUCapability

enum VGUCapability

描述:

硬件加速能力。

VGUClipType

enum VGUClipType

描述:

绘制表面剪切类型。

VGUFillRule

enum VGUFillRule

描述:

填充规则定义。

VGUFillSpread

enum VGUFillSpread

描述:

渐变填充区域外的延展类型。

VGUFilter

enum VGUFilter

描述:

图像滤波类型。

VGUGradientType

enum VGUGradientType

描述:

渐变类型。

VGUJointType

enum VGUJointType

描述:

联接类型。

VGULineCap

enum VGULineCap

描述:

线帽。

VGUPaintType

enum VGUPaintType

描述:

渲染对象

VGUPathCmd

enum VGUPathCmd

描述:

路径绘制指令类型。

VGUPathDataType

enum VGUPathDataType

描述:

路径坐标数据类型。

VGUResult

enum VGUResult

描述:

错误码定义。

VGUTransformType

enum VGUTransformType

描述:

变换类型。

VGUWrapType

enum VGUWrapType

描述:

图像模式填充延展类型。

函数说明

DeviceInitialize()

int32_t DeviceInitialize (DeviceFuncs ** funcs)

描述:

实现显示设备控制接口的初始化，申请操作显示设备控制接口的资源，并获取对应的操作接口。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

DeviceUninitialize()

int32_t DeviceUninitialize (DeviceFuncs * funcs)

描述:

取消显示设备控制接口的初始化，释放控制接口使用到的资源。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GfxInitialize()

int32_t GfxInitialize (GfxFuncs ** funcs)

描述:

获取硬件加速相关的操作接口指针。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GfxUninitialize()

int32_t GfxUninitialize (GfxFuncs * funcs)

描述:

释放硬件加速相关的操作接口指针。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GrallocInitialize()

int32_t GrallocInitialize (GrallocFuncs ** funcs)

描述:

初始化内存模块，并获取内存提供的操作接口。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GrallocUninitialize()

int32_t GrallocUninitialize (GrallocFuncs * funcs)

描述:

取消初始化内存模块，并释放内存操作接口指针。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

LayerInitialize()

int32_t LayerInitialize (LayerFuncs ** funcs)

描述:

实现图层初始化功能，申请图层使用的资源，并获取图层提供的操作接口。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

参见:

LayerUninitialize

LayerUninitialize()

int32_t LayerUninitialize (LayerFuncs * funcs)

描述:

取消图层初始化功能，释放图层使用到的资源，并释放图层操作接口指针。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

参见:

LayerInitialize

VGUGradientClearStop()

VGUResult VGUGradientClearStop (VGUGradient * gradient)

描述:

清除ColorStop。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

VGUGradientColorStop()

VGUResult VGUGradientColorStop (VGUGradient * gradient, const VGUColorStop * colorStop, uint32_t count )

描述:

对渐变添加ColorStop。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

VGUGradientConic()

VGUResult VGUGradientConic (VGUGradient * gradient, VGUScalar cx, VGUScalar cy )

描述:

创建圆锥渐变对象。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

VGUGradientLinear()

VGUResult VGUGradientLinear (VGUGradient * gradient, const VGUPoint * p1, const VGUPoint * p2 )

描述:

创建线性渐变对象。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

VGUGradientMatrix()

VGUResult VGUGradientMatrix (VGUGradient * gradient, const VGUMatrix3 * matrix )

描述:

设置渐变对象的变换矩阵。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

VGUGradientRadial()

VGUResult VGUGradientRadial (VGUGradient * gradient, const VGUPoint * p1, VGUScalar r1, const VGUPoint * p2, VGUScalar r2 )

描述:

创建辐射渐变对象

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

VGUInitialize()

VGUResult VGUInitialize (VGUFuncs ** funcs)

描述:

获取硬件加速相关的操作接口指针。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

VGUMatrixIdentity()

VGUResult VGUMatrixIdentity (VGUMatrix3 * matrix)

描述:

初始化矩阵对象为单位矩阵。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

VGUMatrixRotate()

VGUResult VGUMatrixRotate (VGUMatrix3 * matrix, float degree )

描述:

矩阵变换旋转。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

VGUMatrixScale()

VGUResult VGUMatrixScale (VGUMatrix3 * matrix, float xScale, float yScale )

描述:

矩阵变换缩放。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

VGUMatrixTranslate()

VGUResult VGUMatrixTranslate (VGUMatrix3 * matrix, float x, float y )

描述:

矩阵变换平移。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

VGUPathAppend()

VGUResult VGUPathAppend (VGUPath * path, const VGUPath * subpath )

描述:

添加子路径到当前路径中。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

VGUPathClear()

VGUResult VGUPathClear (VGUPath * path)

描述:

清除路径对象内存。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

VGUPathInit()

VGUResult VGUPathInit (VGUPath * path, VGUPathDataType type, const uint8_t * segments, int numSegments, const uint8_t * data, bool enAlias, VGURect boundBox )

描述:

初始化路径对象。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

VGUUninitialize()

VGUResult VGUUninitialize (VGUFuncs * funcs)

描述:

去初始化硬件加速模块，同时释放硬件加速模块操作函数指针。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

变量说明

alpha0 [1/2]

uint8_t LayerAlpha::alpha0

描述:

alpha0值，取值范围：[0, 255]

alpha0 [2/2]

uint8_t ISurface::alpha0

描述:

Alpha0值，取值范围：[0,255]

alpha1 [1/2]

uint8_t LayerAlpha::alpha1

描述:

alpha1值，取值范围：[0, 255]

alpha1 [2/2]

uint8_t ISurface::alpha1

描述:

Alpha1值，取值范围：[0,255]

alphaRopType

RopType GfxOpt::alphaRopType

描述:

Alpha的Rop类型

bAlphaExt1555

bool ISurface::bAlphaExt1555

描述:

是否使能1555的Alpha扩展

bAlphaMax255

bool ISurface::bAlphaMax255

描述:

图像alpha最大值为255还是128

baseAddr

void* YUVDescInfo::baseAddr

描述:

内存的初始地址

blend

VGUBlendType VGUSurface::blend

描述:

混合叠加模式

blendType

BlendType GfxOpt::blendType

描述:

混合方式

boundBox

VGURect VGUPath::boundBox

描述:

路径最大边界

bpp

int32_t LayerInfo::bpp

描述:

每像素所占bit数

buffer [1/3]

VGUBuffer* VGUMaskLayer::buffer

描述:

蒙版缓存

buffer [2/3]

VGUBuffer* VGUSurface::buffer

描述:

位图缓存

buffer [3/3]

VGUBuffer* VGUImage::buffer

描述:

图像存储缓存

bYCbCrClut

bool ISurface::bYCbCrClut

描述:

CLUT表是否位于 YCbCr 空间

cap

VGULineCap VGUStrokeAttr::cap

描述:

线帽类型

cbcrPhyAddr

uint64_t ISurface::cbcrPhyAddr

描述:

CbCr分量地址

cbcrStride

int32_t ISurface::cbcrStride

描述:

CbCr分量跨度

clipPath

VGUPath* VGUSurface::clipPath

描述:

路径剪切域，如果为空，整个表面直接渲染

clipRect

VGURect* VGUSurface::clipRect

描述:

矩形剪切域，如果为空，整个表面直接渲染

clipType

VGUClipType VGUSurface::clipType

描述:

表面剪切类型

clutPhyAddr

uint64_t ISurface::clutPhyAddr

描述:

Clut表首地址，用作颜色扩展或颜色校正

color [1/5]

uint32_t ILine::color

描述:

线条颜色

color [2/5]

uint32_t ICircle::color

描述:

圆的颜色

color [3/5]

uint32_t Rectangle::color

描述:

矩形颜色

color [4/5]

uint32_t VGUColorStop::color

描述:

偏移位置对应颜色

color [5/5]

uint32_t VGUSolid::color

描述:

颜色值

colorKeyFrom

ColorKey GfxOpt::colorKeyFrom

描述:

色键模式

colorRopType

RopType GfxOpt::colorRopType

描述:

颜色的Rop类型

colorStops

VGUColorStop* VGUGradient::colorStops

描述:

渐变停止颜色数组指针

Commit

int32_t(* DeviceFuncs::Commit) (uint32_t devId, int32_t *fence)

描述:

提交合成送显请求。

图形服务通过该接口向接口实现层提交合成送显请求，如果有硬件合成层，接口实现层需要在这时进行合成，并且把最终合成的数据送到硬件进行显示。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

conic

VGUConic VGUGradient::conic

描述:

圆锥渐变对象

CreateVirtualDisplay

int32_t(* DeviceFuncs::CreateVirtualDisplay) (uint32_t width, uint32_t height, int32_t *format, uint32_t *devId)

描述:

创建虚拟显示设备。

该接口用于创建一个虚拟显示设备。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

cx

VGUScalar VGUConic::cx

描述:

圆弧中心x坐标

cy

VGUScalar VGUConic::cy

描述:

圆弧中心y坐标

data [1/2]

BufferData LayerBuffer::data

描述:

图层buffer数据

data [2/2]

uint8_t* VGUPath::data

描述:

存放路径命令对应坐标数据

DeinitVgu

VGUResult(* VGUFuncs::DeinitVgu) (void)

描述:

去初始化硬件加速。

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

参见:

InitVgu

DestroyVirtualDisplay

int32_t(* DeviceFuncs::DestroyVirtualDisplay) (uint32_t devId)

描述:

销毁虚拟显示设备。

该接口用于销毁指定的虚拟显示设备。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

enableRop

bool GfxOpt::enableRop

描述:

Rop功能使能位

enableScale

bool GfxOpt::enableScale

描述:

缩放功能使能位

enAlias

bool VGUPath::enAlias

描述:

抗锯齿开关

enColorFmt

PixelFormat ISurface::enColorFmt

描述:

图像格式

enGlobalAlpha [1/2]

bool LayerAlpha::enGlobalAlpha

描述:

全局alpha使能标志

enGlobalAlpha [2/2]

bool GfxOpt::enGlobalAlpha

描述:

全局alpha使能位

enPixelAlpha [1/2]

bool LayerAlpha::enPixelAlpha

描述:

像素alpha使能标志

enPixelAlpha [2/2]

bool GfxOpt::enPixelAlpha

描述:

像素alpha使能位

expectedSize

uint32_t AllocInfo::expectedSize

描述:

申请内存大小

fd

int32_t ExtDataHandle::fd

描述:

句柄 fd, -1代表不支持

fenceId

int32_t LayerBuffer::fenceId

描述:

buffer 的fence号。

filter

VGUFilter VGUSurface::filter

描述:

图像滤波类型

format [1/2]

PixelFormat AllocInfo::format

描述:

申请内存格式

format [2/2]

PixelFormat VerifyAllocInfo::format

描述:

分配内存的像素格式

formatCount

uint32_t HDRCapability::formatCount

描述:

支持的HDR格式的数量

formats

HDRFormat* HDRCapability::formats

描述:

支持的HDR格式的数组首地址

freshRate

uint32_t DisplayModeInfo::freshRate

描述:

刷新速率

gAlpha

uint8_t LayerAlpha::gAlpha

描述:

全局alpha值，取值范围：[0, 255]

GetDisplayBacklight

int32_t(* DeviceFuncs::GetDisplayBacklight) (uint32_t devId, uint32_t *level)

描述:

获取显示设备当前的背光值。

图形服务可以通过该接口获取设置显示设备的背光值。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GetDisplayCapability

int32_t(* DeviceFuncs::GetDisplayCapability) (uint32_t devId, DisplayCapability *info)

描述:

获取显示设备能力集。

图形服务可以通过该接口获取显示设备具备哪些显示能力。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GetDisplayColorGamut

int32_t(* DeviceFuncs::GetDisplayColorGamut) (uint32_t devId, ColorGamut *gamut)

描述:

获取显示设备当前的色域模式。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GetDisplayCompChange

int32_t(* DeviceFuncs::GetDisplayCompChange) (uint32_t devId, uint32_t *num, uint32_t *Layers, int32_t *type)

描述:

获取显示设备合成类型有变化的layer。

在合成准备阶段，显示设备会根据设备的合成能力修改图层的合成类型，该接口会返回哪些图层合成类型发生了变化。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GetDisplayGamutMap

int32_t(* DeviceFuncs::GetDisplayGamutMap) (uint32_t devId, GamutMap *gamutMap)

描述:

获取显示设备当前的色域映射模式。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GetDisplayMode

int32_t(* DeviceFuncs::GetDisplayMode) (uint32_t devId, uint32_t *modeId)

描述:

获取显示设备当前的显示模式。

图形服务可以通过该接口获取显示设备当前的显示模式。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GetDisplayPowerStatus

int32_t(* DeviceFuncs::GetDisplayPowerStatus) (uint32_t devId, DispPowerStatus *status)

描述:

获取显示设备当前的电源状态。

图形服务可以通过该接口获设置显示设备的电源状态。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GetDisplayProperty

int32_t(* DeviceFuncs::GetDisplayProperty) (uint32_t devId, uint32_t id, uint64_t *value)

描述:

获取显示设备属性值。

图形服务可以通过该接口获取显示设备具体的属性值。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GetDisplayReleaseFence

int32_t(* DeviceFuncs::GetDisplayReleaseFence) (uint32_t devId, uint32_t *num, uint32_t *layers, int32_t *fences)

描述:

获取显示图层fence。

图形服务在调用接口Commit后，需要通过该接口获取图层的fence信息。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GetDisplaySupportedColorGamuts

int32_t(* DeviceFuncs::GetDisplaySupportedColorGamuts) (uint32_t devId, uint32_t *num, ColorGamut *gamuts)

描述:

获取显示设备支持的色域信息。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GetDisplaySupportedModes

int32_t(* DeviceFuncs::GetDisplaySupportedModes) (uint32_t devId, uint32_t *num, DisplayModeInfo *modes)

描述:

获取显示设备支持的显示模式信息。

图形服务可以通过该接口获取到显示设备支持哪些显示模式。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GetHDRCapabilityInfos

int32_t(* DeviceFuncs::GetHDRCapabilityInfos) (uint32_t devId, HDRCapability *info)

描述:

获取显示设备支持的HDR属性信息。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GetSupportedMetadataKey

int32_t(* DeviceFuncs::GetSupportedMetadataKey) (uint32_t devId, uint32_t *num, HDRMetadataKey *keys)

描述:

获取显示设备支持的 HDRMetadataKey。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

GetWriteBackFrame

int32_t(* DeviceFuncs::GetWriteBackFrame) (uint32_t devId, BufferHandle *buffer, int32_t *fence)

描述:

获取显示设备的回写帧。

该接口用来获取devId指定的回写点数据，接口实现层将显示设备回写点的数据写入到设置的缓存中。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

globalAlpha

uint32_t GfxOpt::globalAlpha

描述:

全局alpha的值

gradient

VGUGradient* VGUPaintStyle::gradient

描述:

渐变对象

h [1/2]

int32_t IRect::h

描述:

矩形框高度

h [2/2]

VGUScalar VGURect::h

描述:

矩形高度

hdl

BufferHandle* LayerBuffer::hdl

描述:

图层buffer句柄

height [1/8]

uint32_t DisplayInfo::height

描述:

显示屏高度

height [2/8]

int32_t LayerInfo::height

描述:

图层高度

height [3/8]

int32_t LayerBuffer::height

描述:

buffer高度

height [4/8]

int32_t ISurface::height

描述:

图像高度

height [5/8]

int32_t DisplayModeInfo::height

描述:

像素高度

height [6/8]

uint32_t AllocInfo::height

描述:

申请内存高度

height [7/8]

uint32_t VerifyAllocInfo::height

描述:

分配内存的高度

height [8/8]

uint32_t VGUBuffer::height

描述:

位图高度

id

int32_t DisplayModeInfo::id

描述:

模式ID

image

VGUImage* VGUPattern::image

描述:

图像对象

InitVgu

VGUResult(* VGUFuncs::InitVgu) (void)

描述:

初始化硬件加速。

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

参见:

DeinitVgu

InvokeDisplayCmd

int32_t(* DeviceFuncs::InvokeDisplayCmd) (uint32_t devId,...)

描述:

调用显示设备命令。

该接口用于图形服务和接口实现层之间的的接口扩展，如果由临时接口新增可以通过该接口进行扩展，不用增加新的接口定义。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

join

VGUJointType VGUStrokeAttr::join

描述:

联结类型

key

HDRMetadataKey HDRMetaData::key

描述:

HDR元数据关键字

linear

VGULinear VGUGradient::linear

描述:

线性渐变对象

m

float VGUMatrix3::m[3][3]

描述:

3x3变换矩阵

mask

VGUMaskLayer* VGUSurface::mask

描述:

蒙版图层，可以为空

matrix [1/2]

VGUMatrix3* VGUImage::matrix

描述:

图像矩阵变换，该参数为空，则内部使用单位变换矩阵

matrix [2/2]

VGUMatrix3* VGUGradient::matrix

描述:

针对渐变对象的变换矩阵

maxAverageLum

float HDRCapability::maxAverageLum

描述:

最大的平均光亮度luminance值

maxLum

float HDRCapability::maxLum

描述:

最大的光亮度luminance值

minLum

float HDRCapability::minLum

描述:

最小的光亮度luminance值

mirrorType

MirrorType GfxOpt::mirrorType

描述:

镜像类型

miterLimit

float VGUStrokeAttr::miterLimit

描述:

最大斜切长度

name [1/2]

char PropertyObject::name[PROPERTY_NAME_LEN]

描述:

属性名称

name [2/2]

char DisplayCapability::name[PROPERTY_NAME_LEN]

描述:

显示设备名称

numSegments

int32_t VGUPath::numSegments

描述:

路径命令总数

opacity [1/3]

uint8_t VGUImage::opacity

描述:

透明度，范围0~255

opacity [2/3]

uint8_t VGUGradient::opacity

描述:

透明度，范围0~255

opacity [3/3]

uint8_t VGUSolid::opacity

描述:

透明度，值范围 0 ~ 255

pattern

VGUPattern* VGUPaintStyle::pattern

描述:

图片模式对象

phyAddr [1/3]

uint64_t BufferData::phyAddr

描述:

物理内存地址

phyAddr [2/3]

uint64_t ISurface::phyAddr

描述:

图像首地址

phyAddr [3/3]

uint64_t VGUBuffer::phyAddr

描述:

位图缓存的物理地址

phyHeight

uint32_t DisplayCapability::phyHeight

描述:

物理高度

phyWidth

uint32_t DisplayCapability::phyWidth

描述:

物理宽度

pitch

int32_t LayerBuffer::pitch

描述:

一行数据所占字节数

pixelFormat

VGUPixelFormat VGUBuffer::pixelFormat

描述:

像素格式

pixFormat [1/2]

PixelFormat LayerInfo::pixFormat

描述:

图层像素格式

pixFormat [2/2]

PixelFormat LayerBuffer::pixFormat

描述:

buffer像素格式r

PrepareDisplayLayers

int32_t(* DeviceFuncs::PrepareDisplayLayers) (uint32_t devId, bool *needFlushFb)

描述:

显示设备合成前准备。

图形服务在合成前需要通过该接口通知显示设备进行合成前的准备工作。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

propertyCount

uint32_t DisplayCapability::propertyCount

描述:

属性数组大小

propId

uint32_t PropertyObject::propId

描述:

属性ID

props

PropertyObject* DisplayCapability::props

描述:

属性数组

QueryCapability

int32_t(* VGUFuncs::QueryCapability) (uint32_t cap)

描述:

查询硬件能力集。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

r

int32_t ICircle::r

描述:

圆的半径

r0

VGUScalar VGURadial::r0

描述:

内圈圆半径

r1

VGUScalar VGURadial::r1

描述:

外圈圆半径

radial

VGURadial VGUGradient::radial

描述:

辐射渐变对象

rect [1/3]

IRect Rectangle::rect

描述:

矩形区域

rect [2/3]

VGURect* VGUMaskLayer::rect

描述:

蒙版矩形

rect [3/3]

VGURect* VGUImage::rect

描述:

图像截取矩形，该参数为空，则截取整个图像

RegDisplayRefreshCallback

int32_t(* DeviceFuncs::RegDisplayRefreshCallback) (uint32_t devId, RefreshCallback callback, void *data)

描述:

刷新请求回调。

注册刷新请求事件回调，当实现层有刷新需求时，实现层通过回调注册的接口通知图形服务。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

RegDisplayVBlankCallback

int32_t(* DeviceFuncs::RegDisplayVBlankCallback) (uint32_t devId, VBlankCallback callback, void *data)

描述:

注册VBlank事件回调。

注册VBlank事件回调，当有VBlank事件发生时接口实现层需要回调注册的接口。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

RegHotPlugCallback

int32_t(* DeviceFuncs::RegHotPlugCallback) (HotPlugCallback callback, void *data)

描述:

注册热插拔事件回调。

注册热插拔事件回调，当有热插拔事件发生时接口实现层需要回调注册的接口。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

RenderBlit

VGUResult(* VGUFuncs::RenderBlit) (VGUSurface *target, const VGUImage *src, uint32_t color)

描述:

对图像进行搬移操作。

搬移过程中同时进行颜色空间转换，矩阵变换操作。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

RenderBlitN

VGUResult(* VGUFuncs::RenderBlitN) (VGUSurface *target, const VGUImage *src, uint16_t count, uint32_t color)

描述:

对多个源图像进行叠加操作。

搬移过程中同时进行颜色空间转换，矩阵变换操作。该接口支持多个源图形同时叠加到目标表面，

对于硬件支持源图像数目可以通过QueryCapability接口查询。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

RenderBlur

VGUResult(* VGUFuncs::RenderBlur) (VGUSurface *target, uint16_t blur)

描述:

对目标表面进行模糊处理。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

RenderCancel

VGUResult(* VGUFuncs::RenderCancel) ()

描述:

取消硬件加速渲染。

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

RenderClearRect

VGUResult(* VGUFuncs::RenderClearRect) (VGUSurface *target, const VGURect *rect, uint32_t color, uint8_t opacity)

描述:

对指定矩形进行颜色清除操作。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

RenderFill

VGUResult(* VGUFuncs::RenderFill) (VGUSurface *target, const VGUPath *path, const VGUMatrix3 *matrix, const VGUFillAttr *attr, const VGUPaintStyle *style)

描述:

使用指定的渲染对象来填充路径。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

RenderStroke

VGUResult(* VGUFuncs::RenderStroke) (VGUSurface *target, const VGUPath *path, const VGUMatrix3 *matrix, const VGUStrokeAttr *attr, const VGUPaintStyle *style)

描述:

使用指定的渲染对象来描边路径。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

RenderSync

VGUResult(* VGUFuncs::RenderSync) (int32_t timeOut)

描述:

同步硬件加速模块绘制或搬移操作。

该函数将阻塞等待硬件绘制完成后继续运行。

参数:

返回:

VGU_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看VGUResult。

reserve[0]

int32_t ExtDataHandle::reserve[0]

描述:

reserve数组

reserveInts

uint32_t ExtDataHandle::reserveInts

描述:

reserve数组的个数

rotAngle

int32_t DisplayInfo::rotAngle

描述:

显示屏旋转角度

rotateType

TransformType GfxOpt::rotateType

描述:

旋转类型

rule

VGUFillRule VGUFillAttr::rule

描述:

填充规格

segment

uint8_t* VGUPath::segment

描述:

存放路径命令数据

SetDisplayBacklight

int32_t(* DeviceFuncs::SetDisplayBacklight) (uint32_t devId, uint32_t level)

描述:

设置显示设备当前的背光值。

图形服务可以通过该接口获设置显示设备的背光值。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

SetDisplayClientBuffer

int32_t(* DeviceFuncs::SetDisplayClientBuffer) (uint32_t devId, const BufferHandle *buffer, int32_t fence)

描述:

设置显示设备的显示缓存。

图形服务可以通过该接口将显示缓存设置给显示设备，显示设备硬件合成结果将会存放在该显示缓存中。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

SetDisplayClientCrop

int32_t(* DeviceFuncs::SetDisplayClientCrop) (uint32_t devId, IRect *rect)

描述:

设置显示设备的裁剪区域。

图形服务可以通过该接口设置显示设备的ClientBuffer的裁剪区域，裁剪区域不能超过ClientBuffer的大小。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

SetDisplayClientDamage

int32_t(* DeviceFuncs::SetDisplayClientDamage) (uint32_t devId, uint32_t num, IRect *rect)

描述:

设置显示设备的显示脏区。

图形服务可以通过该接口设置显示设备脏区，接口实现层可以根据该区域进行区域刷新，脏区是由多个矩形区域组合起来的。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

SetDisplayClientDestRect

int32_t(* DeviceFuncs::SetDisplayClientDestRect) (uint32_t devId, IRect *rect)

描述:

设置显示设备的显示区域。

图形服务可以通过该接口设置显示设备的显示区域。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

SetDisplayColorGamut

int32_t(* DeviceFuncs::SetDisplayColorGamut) (uint32_t devId, ColorGamut gamut)

描述:

设置显示设备当前的色域模式。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

SetDisplayColorTransform

int32_t(* DeviceFuncs::SetDisplayColorTransform) (uint32_t devId, const float *matrix)

描述:

设置显示设备当前的4x4的颜色转换矩阵。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

SetDisplayGamutMap

int32_t(* DeviceFuncs::SetDisplayGamutMap) (uint32_t devId, GamutMap gamutMap)

描述:

设置显示设备当前的色域映射模式。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

SetDisplayMode

int32_t(* DeviceFuncs::SetDisplayMode) (uint32_t devId, uint32_t modeId)

描述:

设置显示设备的显示模式。

图形服务可以通过该接口获设置显示设备的显示模式。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

SetDisplayPowerStatus

int32_t(* DeviceFuncs::SetDisplayPowerStatus) (uint32_t devId, DispPowerStatus status)

描述:

设置显示设备当前的电源状态。

图形服务可以通过该接口获设置显示设备的电源状态。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

SetDisplayProperty

int32_t(* DeviceFuncs::SetDisplayProperty) (uint32_t devId, uint32_t id, uint64_t value)

描述:

设置显示设备属性值。

图形服务可以通过该接口设置显示设备具体的属性值。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

SetDisplayVsyncEnabled

int32_t(* DeviceFuncs::SetDisplayVsyncEnabled) (uint32_t devId, bool enabled)

描述:

使能垂直同步信号。

图形服务可以通过该接口使能或取消垂直同步信号，当有垂直同步信号产生时，接口实现层需要回调图形服务通过RegDisplayVBlankCallback注册的 VBlankCallback 回调。 图形服务在需要刷新显示时需要使能垂直同步信号，在收到VBlankCallback事件回调时再进行合成送显，不需要刷新显示时需要取消垂直同步信号。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

SetVirtualDisplayBuffer

int32_t(* DeviceFuncs::SetVirtualDisplayBuffer) (uint32_t devId, BufferHandle *buffer, int32_t fence)

描述:

设置虚拟屏的输出缓存。

该接口用于设置虚拟屏输出缓存，接口实现层需要将虚拟屏的输出放入到该缓存中，接口实现层需要等待同步栅栏发送信号后才能使用缓存。

参数:

返回:

DISPLAY_SUCCESS 表示执行成功。

其他值表示执行失败，具体错误码查看DispErrCode。

solid

VGUSolid* VGUPaintStyle::solid

描述:

颜色对象

spread

VGUFillSpread VGUGradient::spread

描述:

渐变延伸模式

stop

float VGUColorStop::stop

描述:

颜色偏移位置，值范围是 0.0 ~ 1.0

stopCount

uint16_t VGUGradient::stopCount

描述:

渐变停止颜色个数

stride [1/2]

int32_t ISurface::stride

描述:

图像跨度

stride [2/2]

uint32_t VGUBuffer::stride

描述:

位图stride

supportLayers

uint32_t DisplayCapability::supportLayers

描述:

支持的图层数

supportWriteBack

bool DisplayCapability::supportWriteBack

描述:

是否支持回写

time

int64_t PresentTimestamp::time

描述:

类型对应的值

type [1/7]

LayerType LayerInfo::type

描述:

图层类型，包括图形层、视频层和媒体播放模式

type [2/7]

InterfaceType DisplayCapability::type

描述:

显示屏接口类型

type [3/7]

PresentTimestampType PresentTimestamp::type

描述:

上屏时间戳类型

type [4/7]

VGUPathDataType VGUPath::type

描述:

路径数据存储类型

type [5/7]

uint32_t VGUMatrix3::type

描述:

矩阵变换类型，简单变换为缩放，平移，90度倍数旋转

type [6/7]

VGUGradientType VGUGradient::type

描述:

渐变类型

type [7/7]

VGUPaintType VGUPaintStyle::type

描述:

渲染类型

uOffset

size_t YUVDescInfo::uOffset

描述:

U的偏移量

usage [1/2]

uint64_t AllocInfo::usage

描述:

申请内存的使用场景

usage [2/2]

uint64_t VerifyAllocInfo::usage

描述:

内存的用处

uvStep

size_t YUVDescInfo::uvStep

描述:

UV的step信息

uvStride

size_t YUVDescInfo::uvStride

描述:

UV的stride信息

value [1/2]

uint64_t PropertyObject::value

描述:

属性值

value [2/2]

float HDRMetaData::value

描述:

关键字对应的值

virAddr [1/2]

void* BufferData::virAddr

描述:

虚拟内存地址

virAddr [2/2]

void* VGUBuffer::virAddr

描述:

位图缓存的虚拟地址

virtualDispCount

uint32_t DisplayCapability::virtualDispCount

描述:

支持的虚拟屏数

vOffset

size_t YUVDescInfo::vOffset

描述:

V的偏移量

w [1/2]

int32_t IRect::w

描述:

矩形框宽度

w [2/2]

VGUScalar VGURect::w

描述:

矩形宽度

width [1/9]

uint32_t DisplayInfo::width

描述:

显示屏宽度

width [2/9]

int32_t LayerInfo::width

描述:

图层宽度

width [3/9]

int32_t LayerBuffer::width

描述:

buffer宽度

width [4/9]

int32_t ISurface::width

描述:

图像宽度

width [5/9]

int32_t DisplayModeInfo::width

描述:

像素宽度

width [6/9]

uint32_t AllocInfo::width

描述:

申请内存宽度

width [7/9]

uint32_t VerifyAllocInfo::width

描述:

分配内存的宽度

width [8/9]

uint32_t VGUBuffer::width

描述:

位图宽度

width [9/9]

float VGUStrokeAttr::width

描述:

线宽

wrapx

VGUWrapType VGUPattern::wrapx

描述:

图像水平方向平铺类型

wrapy

VGUWrapType VGUPattern::wrapy

描述:

图像垂直方向平铺类型

x [1/4]

int32_t IRect::x

描述:

矩形框起始x坐标

x [2/4]

int32_t ICircle::x

描述:

圆心x坐标

x [3/4]

VGUScalar VGUPoint::x

描述:

点水平坐标

x [4/4]

VGUScalar VGURect::x

描述:

矩形水平起始坐标

x0 [1/2]

int32_t ILine::x0

描述:

线条起点的x坐标

x0 [2/2]

VGUScalar VGURadial::x0

描述:

内圈圆心水平坐标

x1 [1/3]

int32_t ILine::x1

描述:

线条终点的x坐标

x1 [2/3]

VGUScalar VGULinear::x1

描述:

线性渐变起点水平坐标

x1 [3/3]

VGUScalar VGURadial::x1

描述:

外圈圆心水平坐标

x2

VGUScalar VGULinear::x2

描述:

线性渐变终点水平坐标

y [1/4]

int32_t IRect::y

描述:

矩形框起始y坐标

y [2/4]

int32_t ICircle::y

描述:

圆心y坐标r

y [3/4]

VGUScalar VGUPoint::y

描述:

点垂直坐标

y [4/4]

VGUScalar VGURect::y

描述:

矩形垂直起始坐标

y0 [1/2]

int32_t ILine::y0

描述:

线条起点的y坐标

y0 [2/2]

VGUScalar VGURadial::y0

描述:

内圈圆心垂直坐标

y1 [1/3]

int32_t ILine::y1

描述:

线条终点的y坐标

y1 [2/3]

VGUScalar VGULinear::y1

描述:

线性渐变起点垂直坐标

y1 [3/3]

VGUScalar VGURadial::y1

描述:

外圈圆心垂直坐标

y2

VGUScalar VGULinear::y2

描述:

线性渐变终点垂直坐标

yOffset

size_t YUVDescInfo::yOffset

描述:

Y的偏移量

yStride

size_t YUVDescInfo::yStride

描述:

Y的stride信息