鸿蒙OpenHarmony Native API【NativeWindow】

NativeWindow

Overview

Description:

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

Since:

8

Version:

1.0

Summary

Files

File NameDescription
[external_window.h]定义获取和使用NativeWindow的相关函数

Functions

FunctionDescription
OH_NativeWindow_CreateNativeWindowFromSurface (void *pSurface)struct NativeWindow * 创建NativeWindow实例,每次调用都会产生一个新的NativeWindow实例
OH_NativeWindow_DestroyNativeWindow (struct NativeWindow *window)void 将NativeWindow对象的引用计数减1,当引用计数为0的时候,该NativeWindow对象会被析构掉
OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer (void *pSurfaceBuffer)struct NativeWindowBuffer * 创建NativeWindowBuffer实例,每次调用都会产生一个新的NativeWindowBuffer实例
OH_NativeWindow_DestroyNativeWindowBuffer (struct NativeWindowBuffer *buffer)void 将NativeWindowBuffer对象的引用计数减1,当引用计数为0的时候,该NativeWindowBuffer对象会被析构掉
OH_NativeWindow_NativeWindowRequestBuffer (struct NativeWindow *window, struct NativeWindowBuffer **buffer, int *fenceFd)int32_t 通过NativeWindow对象申请一块NativeWindowBuffer,用以内容生产
OH_NativeWindow_NativeWindowFlushBuffer (struct NativeWindow *window, struct NativeWindowBuffer *buffer, int fenceFd, Region region)int32_t 通过NativeWindow将生产好内容的NativeWindowBuffer放回到Buffer队列中,用以内容消费
OH_NativeWindow_NativeWindowCancelBuffer (struct NativeWindow *window, struct NativeWindowBuffer *buffer)int32_t 通过NativeWindow将之前申请出来的NativeWindowBuffer返还到Buffer队列中,供下次再申请
OH_NativeWindow_NativeWindowHandleOpt (struct NativeWindow *window, int code,…)int32_t 设置/获取NativeWindow的属性,包括设置/获取宽高、内容格式等
OH_NativeWindow_GetBufferHandleFromNative (struct NativeWindowBuffer *buffer)BufferHandle * 通过NativeWindowBuffer获取该buffer的BufferHandle指针
OH_NativeWindow_NativeObjectReference (void *obj)int32_t 增加一个NativeObject的引用计数
OH_NativeWindow_NativeObjectUnreference (void *obj)int32_t 减少一个NativeObject的引用计数,当引用计数减少为0时,该NativeObject将被析构掉
OH_NativeWindow_GetNativeObjectMagic (void *obj)int32_t 获取NativeObject的MagicId

Details

Function

OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer()

struct NativeWindowBuffer* OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer (void * pSurfaceBuffer)

Description:

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

Parameters:

NameDescription
pSurfaceBuffer参数是一个指向生产者buffer的指针,类型为sptrOHOS::SurfaceBuffer

Returns:

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

OH_NativeWindow_CreateNativeWindowFromSurface()

struct NativeWindow* OH_NativeWindow_CreateNativeWindowFromSurface (void * pSurface)

Description:

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

Parameters:

NameDescription
pSurface参数是一个指向生产者ProduceSurface的指针,类型为sptrOHOS::Surface

Returns:

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

OH_NativeWindow_DestroyNativeWindow()

void OH_NativeWindow_DestroyNativeWindow (struct NativeWindow * window)

Description:

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

Parameters:

NameDescription
window参数是一个NativeWindow的结构体实例的指针

OH_NativeWindow_DestroyNativeWindowBuffer()

void OH_NativeWindow_DestroyNativeWindowBuffer (struct NativeWindowBuffer * buffer)

Description:

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

Parameters:

NameDescription
buffer参数是一个NativeWindowBuffer的结构体实例的指针

OH_NativeWindow_GetBufferHandleFromNative()

BufferHandle* OH_NativeWindow_GetBufferHandleFromNative (struct NativeWindowBuffer * buffer)

Description:

通过NativeWindowBuffer获取该buffer的BufferHandle指针

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

Parameters:

NameDescription
buffer参数是一个NativeWindowBuffer的结构体实例的指针

Returns:

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

OH_NativeWindow_GetNativeObjectMagic()

int32_t OH_NativeWindow_GetNativeObjectMagic (void * obj)

Description:

获取NativeObject的MagicId

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

Parameters:

NameDescription
obj参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针

Returns:

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

OH_NativeWindow_NativeObjectReference()

int32_t OH_NativeWindow_NativeObjectReference (void * obj)

Description:

增加一个NativeObject的引用计数

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

Parameters:

NameDescription
obj参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针

Returns:

GSError 返回值为错误码

OH_NativeWindow_NativeObjectUnreference()

int32_t OH_NativeWindow_NativeObjectUnreference (void * obj)

Description:

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

Parameters:

NameDescription
obj参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针

Returns:

GSError

OH_NativeWindow_NativeWindowCancelBuffer()

int32_t OH_NativeWindow_NativeWindowCancelBuffer (struct NativeWindow * window, struct NativeWindowBuffer * buffer )

Description:

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

Parameters:

NameDescription
window参数是一个NativeWindow的结构体实例的指针
buffer参数是一个NativeWindowBuffer的结构体实例的指针

Returns:

GSError 返回值为错误码

OH_NativeWindow_NativeWindowFlushBuffer()

int32_t OH_NativeWindow_NativeWindowFlushBuffer (struct NativeWindow * window, struct NativeWindowBuffer * buffer, int fenceFd, Region region )

Description:

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

Parameters:

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

Returns:

GSError 返回值为错误码

OH_NativeWindow_NativeWindowHandleOpt()

int32_t OH_NativeWindow_NativeWindowHandleOpt (struct NativeWindow * window, int code,  ... )

Description:

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

Parameters:

NameDescription
window参数是一个NativeWindow的结构体实例的指针
code操作码

Returns:

GSError 返回值为错误码

OH_NativeWindow_NativeWindowRequestBuffer()

int32_t OH_NativeWindow_NativeWindowRequestBuffer (struct NativeWindow * window, struct NativeWindowBuffer ** buffer, int * fenceFd )

Description:

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

@syscap SystemCapability.Graphic.Graphic2D.NativeWindow

Parameters:

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

Returns:

GSError 返回值为错误码

  • 13
    点赞
  • 12
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值