HarmonyOS API：NativeWindow

版本：v3.1 Beta

NativeWindow

更新时间: 2023-02-17 09:19

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

起始版本：

8

汇总

文件

结构体

类型定义

枚举

函数

详细描述

枚举类型说明

NativeWindowOperation

enum NativeWindowOperation

描述：

OH_NativeWindow_NativeWindowHandleOpt函数中的操作码

OHHDRMetadataKey

enum OHHDRMetadataKey

描述：

枚举HDR元数据关键字

OHScalingMode

enum OHScalingMode

描述：

缩放模式 Scaling Mode

函数说明

OH_NativeWindow_CreateNativeWindow()

OHNativeWindow* OH_NativeWindow_CreateNativeWindow (void * pSurface)

描述：

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数：

返回：

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

起始版本：

8

OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer()

OHNativeWindowBuffer* OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer (void * pSurfaceBuffer)

描述：

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数：

返回：

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

起始版本：

8

OH_NativeWindow_DestroyNativeWindow()

void OH_NativeWindow_DestroyNativeWindow (OHNativeWindow * window)

描述：

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数：

起始版本：

8

OH_NativeWindow_DestroyNativeWindowBuffer()

void OH_NativeWindow_DestroyNativeWindowBuffer (OHNativeWindowBuffer * buffer)

描述：

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数：

起始版本：

8

OH_NativeWindow_GetBufferHandleFromNative()

BufferHandle* OH_NativeWindow_GetBufferHandleFromNative (OHNativeWindowBuffer * buffer)

描述：

通过NativeWindowBuffer获取该buffer的BufferHandle指针

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数：

返回：

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

起始版本：

8

OH_NativeWindow_GetNativeObjectMagic()

int32_t OH_NativeWindow_GetNativeObjectMagic (void * obj)

描述：

获取NativeObject的MagicId

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数：

返回：

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

起始版本：

8

OH_NativeWindow_NativeObjectReference()

int32_t OH_NativeWindow_NativeObjectReference (void * obj)

描述：

增加一个NativeObject的引用计数

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数：

返回：

GSError 返回值为错误码

起始版本：

8

OH_NativeWindow_NativeObjectUnreference()

int32_t OH_NativeWindow_NativeObjectUnreference (void * obj)

描述：

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数：

返回：

GSError 返回值为错误码

起始版本：

8

OH_NativeWindow_NativeWindowAbortBuffer()

int32_t OH_NativeWindow_NativeWindowAbortBuffer (OHNativeWindow * window, OHNativeWindowBuffer * buffer )

描述：

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数：

返回：

GSError 返回值为错误码

起始版本：

8

OH_NativeWindow_NativeWindowFlushBuffer()

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

描述：

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数：

返回：

GSError 返回值为错误码

起始版本：

8

OH_NativeWindow_NativeWindowHandleOpt()

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

描述：

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数：

返回：

GSError 返回值为错误码

起始版本：

8

OH_NativeWindow_NativeWindowRequestBuffer()

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

描述：

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数：

返回：

GSError 返回值为错误码

起始版本：

8

OH_NativeWindow_NativeWindowSetMetaData()

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

描述：

设置NativeWindow的元数据.

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数：

返回：

GSError 返回值为错误码

起始版本：

9

OH_NativeWindow_NativeWindowSetMetaDataSet()

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

描述：

设置NativeWindow的元数据集。

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数：

返回：

GSError 返回值为错误码

起始版本：

9

OH_NativeWindow_NativeWindowSetScalingMode()

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

描述：

设置NativeWindow的ScalingMode

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数：

返回：

GSError 返回值为错误码

起始版本：

9

OH_NativeWindow_NativeWindowSetTunnelHandle()

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

描述：

设置NativeWindow的TunnelHandle。

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

参数：

返回：

GSError 返回值为错误码

起始版本：

9

文章转载自：​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/_native_window-0000001447290368-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001447290368__汇总​​