HarmonyOS API:模块

joytrian
发布于 2023-4-14 16:40
浏览
0收藏

版本:v3.1 Beta

NativeVsync

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


提供NativeVsync功能。


@syscap SystemCapability.Graphic.Graphic2D.NativeVsync


起始版本:


8

汇总

文件

文件名称

描述

​native_vsync.h​

定义获取和使用NativeVsync的相关函数

引用文件:<native_vsync/native_vsync.h>

函数

函数名称

描述

​OH_NativeVSync_Create​​ (const char *name, unsigned int length)

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

​OH_NativeVSync_Destroy​​ (OH_NativeVSync *nativeVsync)

销毁OH_NativeVSync实例

​OH_NativeVSync_RequestFrame​​ (OH_NativeVSync *nativeVsync, OH_NativeVSync_FrameCallback callback, void *data)

请求下一次vsync信号,当信号到来时,调用回调函数callback

详细描述

函数说明

OH_NativeVSync_Create()

OH_NativeVSync* OH_NativeVSync_Create (const char * name, unsigned int length )

描述:

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

@syscap SystemCapability.Graphic.Graphic2D.NativeVsync

参数:

Name

描述

name

参数表示一个vsync连接的名字

length

参数是name的长度

返回:

返回一个指向OH_NativeVSync实例的指针

起始版本:

8

OH_NativeVSync_Destroy()

void OH_NativeVSync_Destroy (OH_NativeVSync * nativeVsync)

描述:

销毁OH_NativeVSync实例

@syscap SystemCapability.Graphic.Graphic2D.NativeVsync

参数:

Name

描述

nativeVsync

参数是一个指向OH_NativeVSync实例的指针

起始版本:

8

OH_NativeVSync_RequestFrame()

int OH_NativeVSync_RequestFrame (OH_NativeVSync * nativeVsync, OH_NativeVSync_FrameCallback callback, void * data )

描述:

请求下一次vsync信号,当信号到来时,调用回调函数callback

@syscap SystemCapability.Graphic.Graphic2D.NativeVsync

参数:

Name

描述

nativeVsync

参数是一个指向OH_NativeVSync实例的指针

callback

参数是一个OH_NativeVSync_FrameCallback类型的函数指针,当下一次vsync信号到来时会被调用

data

参数是一个指向用户自定义数据结构的指针,类型是void*

返回:

返回一个由GSError定义的int32_t类型的错误码

起始版本:

8

Image

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


提供获取pixelmap的数据和信息的接口方法。


@Syscap SystemCapability.Multimedia.Image


起始版本:


8

汇总

文件

文件名称

描述

​image_pixel_map_napi.h​

声明可以锁定并访问pixelmap数据的方法,声明解锁的方法。

引用文件:<multimedia/image_framework/image_pixel_map_napi.h>

结构体

结构体名称

描述

​OhosPixelMapInfo​

用于定义 pixel map 的相关信息。

枚举

枚举名称

描述

{ OHOS_IMAGE_RESULT_SUCCESS = 0,

OHOS_IMAGE_RESULT_BAD_PARAMETER = -1 }

函数方法返回值的错误码的枚举。

{ OHOS_PIXEL_MAP_FORMAT_NONE = 0,

OHOS_PIXEL_MAP_FORMAT_RGBA_8888 = 3,

OHOS_PIXEL_MAP_FORMAT_RGB_565 = 2 }

pixel 格式的枚举。

函数

函数名称

描述

​OH_GetImageInfo​​​ (napi_env env, napi_value value, ​​OhosPixelMapInfo​​ *info)

获取 PixelMap 的信息,并记录信息到​​OhosPixelMapInfo​​结构中。

​OH_AccessPixels​​ (napi_env env, napi_value value, void **addrPtr)

获取PixelMap对象数据的内存地址,并锁定该内存。

​OH_UnAccessPixels​​ (napi_env env, napi_value value)

释放PixelMap对象数据的内存锁, 用于匹配方法​​OH_AccessPixels​​。

详细描述

枚举类型说明

anonymous enum

anonymous enum

描述:

函数方法返回值的错误码的枚举。

枚举值

描述

OHOS_IMAGE_RESULT_SUCCESS

成功的结果。

OHOS_IMAGE_RESULT_BAD_PARAMETER

无效值。

起始版本:

8

anonymous enum

anonymous enum

描述:

pixel 格式的枚举。

枚举值

描述

OHOS_PIXEL_MAP_FORMAT_NONE

未知的格式。

OHOS_PIXEL_MAP_FORMAT_RGBA_8888

32-bit RGBA。由 R, G, B组成,包括 A 都需要占用 8 bits。存储顺序是从高位到低位。

OHOS_PIXEL_MAP_FORMAT_RGB_565

16-bit RGB。仅由 R, G, B 组成。存储顺序是从高位到低位: 红色占用5 bits,绿色占用6 bits,蓝色占用5 bits。

起始版本:

8

函数说明

OH_AccessPixels()

int32_t OH_AccessPixels (napi_env env, napi_value value, void ** addrPtr )

描述:

获取PixelMap对象数据的内存地址,并锁定该内存。

函数执行成功后,*addrPtr就是获取的待访问的内存地址。访问操作完成后,必须要使用​​OH_UnAccessPixels​​来释放锁, 否则的话资源无法被释放。待解锁后,内存地址就不可以再被访问和操作。

参数:

Name

描述

env

napi的环境指针。

value

应用层的 PixelMap 对象。

addrPtr

用于指向的内存地址的双指针对象。

参见:

​OH_UnAccessPixels​

返回:

操作成功则返回OHOS_IMAGE_RESULT_SUCCESS; 如果操作失败,则返回错误码。

起始版本:

8

OH_GetImageInfo()

int32_t OH_GetImageInfo (napi_env env, napi_value value, OhosPixelMapInfo * info )

描述:

获取 PixelMap 的信息,并记录信息到​​OhosPixelMapInfo​​结构中。

参数:

Name

描述

env

napi的环境指针。

value

应用层的 PixelMap 对象。

info

用于保存信息的指针对象。更多细节, 参看 ​​OhosPixelMapInfo​​。

返回:

如果获取并保存信息成功,则返回0; 如果操作失败,则返回错误码。

参见:

​OhosPixelMapInfo​

起始版本:

8

OH_UnAccessPixels()

int32_t OH_UnAccessPixels (napi_env env, napi_value value )

描述:

释放PixelMap对象数据的内存锁, 用于匹配方法​​OH_AccessPixels​​。

参数:

Name

描述

env

napi的环境指针。

value

应用层的 PixelMap 对象。

返回:

操作成功则返回OHOS_IMAGE_RESULT_SUCCESS; 如果操作失败,则返回错误码。

参见:

AccessPixels

起始版本:

8


文章转载自:​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/image-0000001446810532-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001446810532__汇总​

已于2023-4-14 16:40:23修改
收藏
回复
举报
回复
    相关推荐