NativeWindow


NativeWindow

提供NativeWindow功能,主要用来和egl对接。

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

自从:

8

汇总

文件

文件名称 描述
external_window.h 定义获取和使用NativeWindow的相关函数

结构体

结构体名称 描述
Region 表示本地窗口NativeWindow需要更新内容的矩形区域(脏区)
OHHDRMetaData HDR元数据结构体定义
OHExtDataHandle 扩展数据句柄结构体定义

类型定义

类型定义名称 描述
OHNativeWindow 提供对NativeWindow的访问功能
OHNativeWindowBuffer 提供对NativeWindow的访问功能
Region 表示本地窗口NativeWindow需要更新内容的矩形区域(脏区)

枚举

枚举名称 描述
NativeWindowOperation { SET_BUFFER_GEOMETRY, GET_BUFFER_GEOMETRY, GET_FORMAT, SET_FORMAT, GET_USAGE, SET_USAGE, SET_STRIDE, GET_STRIDE, SET_SWAP_INTERVAL, GET_SWAP_INTERVAL, SET_TIMEOUT, GET_TIMEOUT, SET_COLOR_GAMUT, GET_COLOR_GAMUT, SET_TRANSFORM, GET_TRANSFORM, SET_UI_TIMESTAMP } OH_NativeWindow_NativeWindowHandleOpt函数中的操作码
OHScalingMode { OH_SCALING_MODE_FREEZE = 0, OH_SCALING_MODE_SCALE_TO_WINDOW, OH_SCALING_MODE_SCALE_CROP, OH_SCALING_MODE_NO_SCALE_CROP } 缩放模式 Scaling Mode
OHHDRMetadataKey { OH_METAKEY_RED_PRIMARY_X = 0, OH_METAKEY_RED_PRIMARY_Y = 1, OH_METAKEY_GREEN_PRIMARY_X = 2, OH_METAKEY_GREEN_PRIMARY_Y = 3, OH_METAKEY_BLUE_PRIMARY_X = 4, OH_METAKEY_BLUE_PRIMARY_Y = 5, OH_METAKEY_WHITE_PRIMARY_X = 6, OH_METAKEY_WHITE_PRIMARY_Y = 7, OH_METAKEY_MAX_LUMINANCE = 8, OH_METAKEY_MIN_LUMINANCE = 9, OH_METAKEY_MAX_CONTENT_LIGHT_LEVEL = 10, OH_METAKEY_MAX_FRAME_AVERAGE_LIGHT_LEVEL = 11, OH_METAKEY_HDR10_PLUS = 12, OH_METAKEY_HDR_VIVID = 13 } 枚举HDR元数据关键字

函数

函数名称 描述
OH_NativeWindow_CreateNativeWindow (void *pSurface) 创建NativeWindow实例,每次调用都会产生一个新的NativeWindow实例
OH_NativeWindow_DestroyNativeWindow (OHNativeWindow *window) 将NativeWindow对象的引用计数减1,当引用计数为0的时候,该NativeWindow对象会被析构掉
OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer (void *pSurfaceBuffer) 创建NativeWindowBuffer实例,每次调用都会产生一个新的NativeWindowBuffer实例
OH_NativeWindow_DestroyNativeWindowBuffer (OHNativeWindowBuffer *buffer) 将NativeWindowBuffer对象的引用计数减1,当引用计数为0的时候,该NativeWindowBuffer对象会被析构掉
OH_NativeWindow_NativeWindowRequestBuffer (OHNativeWindow *window, OHNativeWindowBuffer **buffer, int *fenceFd) 通过NativeWindow对象申请一块NativeWindowBuffer,用以内容生产
OH_NativeWindow_NativeWindowFlushBuffer (OHNativeWindow *window, OHNativeWindowBuffer *buffer, int fenceFd, Region region) 通过NativeWindow将生产好内容的NativeWindowBuffer放回到Buffer队列中,用以内容消费
OH_NativeWindow_NativeWindowAbortBuffer (OHNativeWindow *window, OHNativeWindowBuffer *buffer) 通过NativeWindow将之前申请出来的NativeWindowBuffer返还到Buffer队列中,供下次再申请
OH_NativeWindow_NativeWindowHandleOpt (OHNativeWindow *window, int code,...) 设置/获取NativeWindow的属性,包括设置/获取宽高、内容格式等
OH_NativeWindow_GetBufferHandleFromNative (OHNativeWindowBuffer *buffer) 通过NativeWindowBuffer获取该buffer的BufferHandle指针
OH_NativeWindow_NativeObjectReference (void *obj) 增加一个NativeObject的引用计数
OH_NativeWindow_NativeObjectUnreference (void *obj) 减少一个NativeObject的引用计数,当引用计数减少为0时,该NativeObject将被析构掉
OH_NativeWindow_GetNativeObjectMagic (void *obj) 获取NativeObject的MagicId
OH_NativeWindow_NativeWindowSetScalingMode (OHNativeWindow *window, uint32_t sequence, OHScalingMode scalingMode) 设置NativeWindow的ScalingMode
OH_NativeWindow_NativeWindowSetMetaData (OHNativeWindow *window, uint32_t sequence, int32_t size, const OHHDRMetaData *metaData) 设置NativeWindow的元数据
OH_NativeWindow_NativeWindowSetMetaDataSet (OHNativeWindow *window, uint32_t sequence, OHHDRMetadataKey key, int32_t size, const uint8_t *metaData) 设置NativeWindow的元数据集。
OH_NativeWindow_NativeWindowSetTunnelHandle (OHNativeWindow *window, const OHExtDataHandle *handle) 设置NativeWindow的TunnelHandle。

详细描述

枚举类型说明

NativeWindowOperation

enum NativeWindowOperation
1

描述:

OH_NativeWindow_NativeWindowHandleOpt函数中的操作码

枚举值 说明
SET_BUFFER_GEOMETRY 设置本地窗口缓冲区几何图形, 函数中的可变参数是 [输入] int32_t height,[输入] int32_t width。
GET_BUFFER_GEOMETRY 获取本地窗口缓冲区几何图形, 函数中的可变参数是 [输出] int32_t *height, [输出] int32_t *width。
GET_FORMAT 获取本地窗口缓冲区格式, 函数中的可变参数是 [输出] int32_t *format。
SET_FORMAT 设置本地窗口缓冲区格式, 函数中的可变参数是 [输入] int32_t format。
GET_USAGE 获取本地窗口缓冲区格式, 函数中的可变参数是 [输出] int32_t *usage。
SET_USAGE 设置本地窗口缓冲区使用方式, 函数中的可变参数是 [输入] int32_t usage。
SET_STRIDE 设置本地窗口缓冲区步幅, 函数中的可变参数是 [输入] int32_t stride。
GET_STRIDE 获取本地窗口缓冲区步幅, 函数中的可变参数是 [输出] int32_t *stride。
SET_SWAP_INTERVAL 设置本地窗口缓冲区交换间隔, 函数中的可变参数是 [输入] int32_t interval。
GET_SWAP_INTERVAL 获取本地窗口缓冲区交换间隔, 函数中的可变参数是 [输出] int32_t *interval。
SET_TIMEOUT 设置请求本地窗口缓冲区的超时等待时间, 函数中的可变参数是 [输入] int32_t timeout。
GET_TIMEOUT 获取请求本地窗口缓冲区的超时等待时间, 函数中的可变参数是 [输出] int32_t *timeout。
SET_COLOR_GAMUT 设置本地窗口缓冲区色彩空间, 函数中的可变参数是 [输入] int32_t colorGamut。
GET_COLOR_GAMUT 获取本地窗口缓冲区色彩空间, 函数中的可变参数是 [out int32_t *colorGamut]。
SET_TRANSFORM 设置本地窗口缓冲区变换, 函数中的可变参数是 [输入] int32_t transform。
GET_TRANSFORM 获取本地窗口缓冲区变换, 函数中的可变参数是 [输出] int32_t *transform。
SET_UI_TIMESTAMP 设置本地窗口缓冲区UI时间戳, 函数中的可变参数是 [输入] uint64_t uiTimestamp。

OHHDRMetadataKey

enum OHHDRMetadataKey
1

描述:

枚举HDR元数据关键字

枚举值 描述
OH_METAKEY_RED_PRIMARY_X 红基色X坐标
OH_METAKEY_RED_PRIMARY_Y 红基色Y坐标
OH_METAKEY_GREEN_PRIMARY_X 绿基色X坐标
OH_METAKEY_GREEN_PRIMARY_Y 绿基色Y坐标
OH_METAKEY_BLUE_PRIMARY_X 蓝基色X坐标
OH_METAKEY_BLUE_PRIMARY_Y 蓝基色Y坐标
OH_METAKEY_WHITE_PRIMARY_X 白点X坐标
OH_METAKEY_WHITE_PRIMARY_Y 白点Y坐标
OH_METAKEY_MAX_LUMINANCE 最大的光亮度
OH_METAKEY_MIN_LUMINANCE 最小的光亮度
OH_METAKEY_MAX_CONTENT_LIGHT_LEVEL 最大的内容亮度水平
OH_METAKEY_MAX_FRAME_AVERAGE_LIGHT_LEVEL 最大的帧平均亮度水平
OH_METAKEY_HDR10_PLUS HDR10 Plus
OH_METAKEY_HDR_VIVID Vivid

OHScalingMode

enum OHScalingMode
1

描述:

缩放模式 Scaling Mode

枚举值 描述
OH_SCALING_MODE_FREEZE 在接收到窗口大小的缓冲区之前,不可以更新窗口内容
OH_SCALING_MODE_SCALE_TO_WINDOW 缓冲区在二维中缩放以匹配窗口大小
OH_SCALING_MODE_SCALE_CROP 缓冲区被统一缩放,使得缓冲区的较小尺寸与窗口大小匹配
OH_SCALING_MODE_NO_SCALE_CROP 窗口被裁剪为缓冲区裁剪矩形的大小,裁剪矩形之外的像素被视为完全透明

函数说明

OH_NativeWindow_CreateNativeWindow()

OHNativeWindow* OH_NativeWindow_CreateNativeWindow (void * pSurface)
1

描述:

创建NativeWindow实例,每次调用都会产生一个新的NativeWindow实例

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数:

名称 描述
pSurface 参数是一个指向生产者ProduceSurface的指针,类型为sptr<OHOS::Surface>

返回:

返回一个指针,指向NativeWindow的结构体实例

自从:

8

OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer()

OHNativeWindowBuffer* OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer (void * pSurfaceBuffer)
1

描述:

创建NativeWindowBuffer实例,每次调用都会产生一个新的NativeWindowBuffer实例

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数:

名称 描述
pSurfaceBuffer 参数是一个指向生产者buffer的指针,类型为sptr<OHOS::SurfaceBuffer>

返回:

返回一个指针,指向NativeWindowBuffer的结构体实例

自从:

8

OH_NativeWindow_DestroyNativeWindow()

void OH_NativeWindow_DestroyNativeWindow (OHNativeWindow * window)
1

描述:

将NativeWindow对象的引用计数减1,当引用计数为0的时候,该NativeWindow对象会被析构掉

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数:

名称 描述
window 参数是一个NativeWindow的结构体实例的指针

自从:

8

OH_NativeWindow_DestroyNativeWindowBuffer()

void OH_NativeWindow_DestroyNativeWindowBuffer (OHNativeWindowBuffer * buffer)
1

描述:

将NativeWindowBuffer对象的引用计数减1,当引用计数为0的时候,该NativeWindowBuffer对象会被析构掉

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数:

名称 描述
buffer 参数是一个NativeWindowBuffer的结构体实例的指针

自从:

8

OH_NativeWindow_GetBufferHandleFromNative()

BufferHandle* OH_NativeWindow_GetBufferHandleFromNative (OHNativeWindowBuffer * buffer)
1

描述:

通过NativeWindowBuffer获取该buffer的BufferHandle指针

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数:

名称 描述
buffer 参数是一个NativeWindowBuffer的结构体实例的指针

返回:

BufferHandle 返回一个指针,指向BufferHandle的结构体实例

自从:

8

OH_NativeWindow_GetNativeObjectMagic()

int32_t OH_NativeWindow_GetNativeObjectMagic (void * obj)
1

描述:

获取NativeObject的MagicId

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数:

名称 描述
obj 参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针

返回:

MagicId 返回值为魔鬼数字,每个NativeObject唯一

自从:

8

OH_NativeWindow_NativeObjectReference()

int32_t OH_NativeWindow_NativeObjectReference (void * obj)
1

描述:

增加一个NativeObject的引用计数

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数:

名称 描述
obj 参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针

返回:

GSError 返回值为错误码

自从:

8

OH_NativeWindow_NativeObjectUnreference()

int32_t OH_NativeWindow_NativeObjectUnreference (void * obj)
1

描述:

减少一个NativeObject的引用计数,当引用计数减少为0时,该NativeObject将被析构掉

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数:

名称 描述
obj 参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针

返回:

GSError 返回值为错误码

自从:

8

OH_NativeWindow_NativeWindowAbortBuffer()

int32_t OH_NativeWindow_NativeWindowAbortBuffer (OHNativeWindow * window, OHNativeWindowBuffer * buffer )
1

描述:

通过NativeWindow将之前申请出来的NativeWindowBuffer返还到Buffer队列中,供下次再申请

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数:

名称 描述
window 参数是一个NativeWindow的结构体实例的指针
buffer 参数是一个NativeWindowBuffer的结构体实例的指针

返回:

GSError 返回值为错误码

自从:

8

OH_NativeWindow_NativeWindowFlushBuffer()

int32_t OH_NativeWindow_NativeWindowFlushBuffer (OHNativeWindow * window, OHNativeWindowBuffer * buffer, int fenceFd, Region region )
1

描述:

通过NativeWindow将生产好内容的NativeWindowBuffer放回到Buffer队列中,用以内容消费

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数:

名称 描述
window 参数是一个NativeWindow的结构体实例的指针
buffer 参数是一个NativeWindowBuffer的结构体实例的指针
fenceFd 参数是一个文件描述符句柄,用以同步时序
region 参数表示一块脏区域,该区域有内容更新

返回:

GSError 返回值为错误码

自从:

8

OH_NativeWindow_NativeWindowHandleOpt()

int32_t OH_NativeWindow_NativeWindowHandleOpt (OHNativeWindow * window, int code,  ... )
1

描述:

设置/获取NativeWindow的属性,包括设置/获取宽高、内容格式等

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数:

名称 描述
window 参数是一个NativeWindow的结构体实例的指针
code 表示操作码,详见NativeWindowOperation
... 可变参数,必须与操作码一一对应

返回:

GSError 返回值为错误码

自从:

8

OH_NativeWindow_NativeWindowRequestBuffer()

int32_t OH_NativeWindow_NativeWindowRequestBuffer (OHNativeWindow * window, OHNativeWindowBuffer ** buffer, int * fenceFd )
1

描述:

通过NativeWindow对象申请一块NativeWindowBuffer,用以内容生产

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数:

名称 描述
window 参数是一个NativeWindow的结构体实例的指针
buffer 参数是一个NativeWindowBuffer的结构体实例的二级指针
fenceFd 参数是一个文件描述符句柄

返回:

GSError 返回值为错误码

自从:

8

OH_NativeWindow_NativeWindowSetMetaData()

int32_t OH_NativeWindow_NativeWindowSetMetaData (OHNativeWindow * window, uint32_t sequence, int32_t size, const OHHDRMetaData * metaData )
1

描述:

设置NativeWindow的元数据.

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数:

名称 描述
window 参数是一个NativeWindow的结构体实例的指针
sequence 生产缓冲区的序列
size OHHDRMetaData数组的大小
metaDate 指向OHHDRMetaData数组的指针

返回:

GSError 返回值为错误码

自从:

9

OH_NativeWindow_NativeWindowSetMetaDataSet()

int32_t OH_NativeWindow_NativeWindowSetMetaDataSet (OHNativeWindow * window, uint32_t sequence, OHHDRMetadataKey key, int32_t size, const uint8_t * metaData )
1

描述:

设置NativeWindow的元数据集。

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数:

名称 描述
window 参数是一个NativeWindow的结构体实例的指针。
sequence 生产缓冲区的序列。
key 枚举值OHHDRMetadataKey
size uint8_t向量的大小
metaDate 指向uint8_t向量的指针

返回:

GSError 返回值为错误码

自从:

9

OH_NativeWindow_NativeWindowSetScalingMode()

int32_t OH_NativeWindow_NativeWindowSetScalingMode (OHNativeWindow * window, uint32_t sequence, OHScalingMode scalingMode )
1

描述:

设置NativeWindow的ScalingMode

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数:

名称 描述
window 参数是一个NativeWindow的结构体实例的指针
sequence 生产缓冲区的序列
scalingMode 枚举值OHScalingMode

返回:

GSError 返回值为错误码

自从:

9

OH_NativeWindow_NativeWindowSetTunnelHandle()

int32_t OH_NativeWindow_NativeWindowSetTunnelHandle (OHNativeWindow * window, const OHExtDataHandle * handle )
1

描述:

设置NativeWindow的TunnelHandle。

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数:

名称 描述
window 参数是一个NativeWindow的结构体实例的指针
handle 指向OHExtDataHandle的指针

返回:

GSError 返回值为错误码

自从:

9