Skip to content

D
Docs

OpenHarmony / Docs
接近 2 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 92eb22d4 编写于 作者: Z zengyawen
浏览文件
操作

update native apis 

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 c154e773
展开全部 隐藏空白更改
内联 并排
Showing with 223 addition and 223 deletion
zh-cn/application-dev/reference/native-apis/_hi_log.md
浏览文件 @ 92eb22d4
...@@ -30,13 +30,13 @@ HiLog模块实现日志打印功能。 ...@@ -30,13 +30,13 @@ HiLog模块实现日志打印功能。
| 宏定义名称 | 描述 | | 宏定义名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [LOG_DOMAIN](#logdomain) 0 | 日志所对应的业务领域，用于标识业务的子系统、模块。 | | [LOG_DOMAIN](#log_domain) 0 | 日志所对应的业务领域，用于标识业务的子系统、模块。 |
| [LOG_TAG](#logtag) NULL | 字符串常量，标识调用所在的类或者业务。 | | [LOG_TAG](#log_tag) NULL | 字符串常量，标识调用所在的类或者业务。 |
| [OH_LOG_DEBUG](#ohlogdebug)(type, ...) ((void)[OH_LOG_Print](#ohlogprint)((type), LOG_DEBUG, LOG_DOMAIN, LOG_TAG, \__VA_ARGS__)) | DEBUG级别写日志，宏封装接口。 | | [OH_LOG_DEBUG](#oh_log_debug)(type, ...) ((void)[OH_LOG_Print](#oh_log_print)((type), LOG_DEBUG, LOG_DOMAIN, LOG_TAG, \__VA_ARGS__)) | DEBUG级别写日志，宏封装接口。 |
| [OH_LOG_INFO](#ohloginfo)(type, ...) ((void)[OH_LOG_Print](#ohlogprint)((type), LOG_INFO, LOG_DOMAIN, LOG_TAG, \__VA_ARGS__)) | INFO级别写日志，宏封装接口。 | | [OH_LOG_INFO](#oh_log_info)(type, ...) ((void)[OH_LOG_Print](#oh_log_print)((type), LOG_INFO, LOG_DOMAIN, LOG_TAG, \__VA_ARGS__)) | INFO级别写日志，宏封装接口。 |
| [OH_LOG_WARN](#ohlogwarn)(type, ...) ((void)[OH_LOG_Print](#ohlogprint)((type), LOG_WARN, LOG_DOMAIN, LOG_TAG, \__VA_ARGS__)) | WARN级别写日志，宏封装接口。 | | [OH_LOG_WARN](#oh_log_warn)(type, ...) ((void)[OH_LOG_Print](#oh_log_print)((type), LOG_WARN, LOG_DOMAIN, LOG_TAG, \__VA_ARGS__)) | WARN级别写日志，宏封装接口。 |
| [OH_LOG_ERROR](#ohlogerror)(type, ...) ((void)[OH_LOG_Print](#ohlogprint)((type), LOG_ERROR, LOG_DOMAIN, LOG_TAG, \__VA_ARGS__)) | ERROR级别写日志，宏封装接口。 | | [OH_LOG_ERROR](#oh_log_error)(type, ...) ((void)[OH_LOG_Print](#oh_log_print)((type), LOG_ERROR, LOG_DOMAIN, LOG_TAG, \__VA_ARGS__)) | ERROR级别写日志，宏封装接口。 |
| [OH_LOG_FATAL](#ohlogfatal)(type, ...) ((void)HiLogPrint((type), LOG_FATAL, LOG_DOMAIN, LOG_TAG, \__VA_ARGS__)) | FATAL级别写日志，宏封装接口。 | | [OH_LOG_FATAL](#oh_log_fatal)(type, ...) ((void)HiLogPrint((type), LOG_FATAL, LOG_DOMAIN, LOG_TAG, \__VA_ARGS__)) | FATAL级别写日志，宏封装接口。 |
### 枚举 ### 枚举
...@@ -51,8 +51,8 @@ HiLog模块实现日志打印功能。 ...@@ -51,8 +51,8 @@ HiLog模块实现日志打印功能。
| 函数名称 | 描述 | | 函数名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [OH_LOG_Print](#ohlogprint) ([LogType](#logtype) type, [LogLevel](#loglevel) level, unsigned int domain, const char \*tag, const char \*fmt,...) \_\_attribute\_\_((\_\_format\_\_(os\_log | 写日志接口。 | | [OH_LOG_Print](#oh_log_print) ([LogType](#logtype) type, [LogLevel](#loglevel) level, unsigned int domain, const char \*tag, const char \*fmt,...) \_\_attribute\_\_((\_\_format\_\_(os\_log | 写日志接口。 |
| [OH_LOG_IsLoggable](#ohlogisloggable) (unsigned int domain, const char \*tag, [LogLevel](#loglevel) level) | 检查指定业务领域、TAG、级别的日志是否可以打印。 | | [OH_LOG_IsLoggable](#oh_log_isloggable) (unsigned int domain, const char \*tag, [LogLevel](#loglevel) level) | 检查指定业务领域、TAG、级别的日志是否可以打印。 |
## 详细描述 ## 详细描述
...@@ -118,7 +118,7 @@ DEBUG级别写日志，宏封装接口。 ...@@ -118,7 +118,7 @@ DEBUG级别写日志，宏封装接口。
**参见：** **参见：**
[OH_LOG_Print](#ohlogprint) [OH_LOG_Print](#oh_log_print)
**自从：** **自从：**
...@@ -148,7 +148,7 @@ ERROR级别写日志，宏封装接口。 ...@@ -148,7 +148,7 @@ ERROR级别写日志，宏封装接口。
**参见：** **参见：**
[OH_LOG_Print](#ohlogprint) [OH_LOG_Print](#oh_log_print)
**自从：** **自从：**
...@@ -178,7 +178,7 @@ FATAL级别写日志，宏封装接口。 ...@@ -178,7 +178,7 @@ FATAL级别写日志，宏封装接口。
**参见：** **参见：**
[OH_LOG_Print](#ohlogprint) [OH_LOG_Print](#oh_log_print)
**自从：** **自从：**
...@@ -208,7 +208,7 @@ INFO级别写日志，宏封装接口。 ...@@ -208,7 +208,7 @@ INFO级别写日志，宏封装接口。
**参见：** **参见：**
[OH_LOG_Print](#ohlogprint) [OH_LOG_Print](#oh_log_print)
**自从：** **自从：**
...@@ -238,7 +238,7 @@ WARN级别写日志，宏封装接口。 ...@@ -238,7 +238,7 @@ WARN级别写日志，宏封装接口。
**参见：** **参见：**
[OH_LOG_Print](#ohlogprint) [OH_LOG_Print](#oh_log_print)
**自从：** **自从：**
......
zh-cn/application-dev/reference/native-apis/_native_vsync.md
浏览文件 @ 92eb22d4
...@@ -27,9 +27,9 @@ ...@@ -27,9 +27,9 @@
| 函数名称 | 描述 | | 函数名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [OH_NativeVSync_Create](#ohnativevsynccreate) (const char \*name, unsigned int length) | 创建一个OH_NativeVSync实例，每次调用都会产生一个新的实例 | | [OH_NativeVSync_Create](#oh_nativevsync_create) (const char \*name, unsigned int length) | 创建一个OH_NativeVSync实例，每次调用都会产生一个新的实例 |
| [OH_NativeVSync_Destroy](#ohnativevsyncdestroy) (OH_NativeVSync \*nativeVsync) | 销毁OH_NativeVSync实例 | | [OH_NativeVSync_Destroy](#oh_nativevsync_destroy) (OH_NativeVSync \*nativeVsync) | 销毁OH_NativeVSync实例 |
| [OH_NativeVSync_RequestFrame](#ohnativevsyncrequestframe) (OH_NativeVSync \*nativeVsync, OH_NativeVSync_FrameCallback callback, void \*data) | 请求下一次vsync信号，当信号到来时，调用回调函数callback | | [OH_NativeVSync_RequestFrame](#oh_nativevsync_requestframe) (OH_NativeVSync \*nativeVsync, OH_NativeVSync_FrameCallback callback, void \*data) | 请求下一次vsync信号，当信号到来时，调用回调函数callback |
## 详细描述 ## 详细描述
......
zh-cn/application-dev/reference/native-apis/_native_window.md
浏览文件 @ 92eb22d4
...@@ -27,18 +27,18 @@ ...@@ -27,18 +27,18 @@
| 函数名称 | 描述 | | 函数名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [OH_NativeWindow_CreateNativeWindowFromSurface](#ohnativewindowcreatenativewindowfromsurface)&nbsp;(void&nbsp;\*pSurface) | 创建NativeWindow实例，每次调用都会产生一个新的NativeWindow实例 | | [OH_NativeWindow_CreateNativeWindowFromSurface](#oh_nativewindow_createnativewindowfromsurface) (void \*pSurface) | 创建NativeWindow实例，每次调用都会产生一个新的NativeWindow实例 |
| [OH_NativeWindow_DestroyNativeWindow](#ohnativewindowdestroynativewindow)&nbsp;(struct&nbsp;NativeWindow&nbsp;\*window) | 将NativeWindow对象的引用计数减1，当引用计数为0的时候，该NativeWindow对象会被析构掉 | | [OH_NativeWindow_DestroyNativeWindow](#oh_nativewindow_destroynativewindow) (struct NativeWindow \*window) | 将NativeWindow对象的引用计数减1，当引用计数为0的时候，该NativeWindow对象会被析构掉 |
| [OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer](#ohnativewindowcreatenativewindowbufferfromsurfacebuffer)&nbsp;(void&nbsp;\*pSurfaceBuffer) | 创建NativeWindowBuffer实例，每次调用都会产生一个新的NativeWindowBuffer实例 | | [OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer](#oh_nativewindow_createnativewindowbufferfromsurfacebuffer) (void \*pSurfaceBuffer) | 创建NativeWindowBuffer实例，每次调用都会产生一个新的NativeWindowBuffer实例 |
| [OH_NativeWindow_DestroyNativeWindowBuffer](#ohnativewindowdestroynativewindowbuffer)&nbsp;(struct&nbsp;NativeWindowBuffer&nbsp;\*buffer) | 将NativeWindowBuffer对象的引用计数减1，当引用计数为0的时候，该NativeWindowBuffer对象会被析构掉 | | [OH_NativeWindow_DestroyNativeWindowBuffer](#oh_nativewindow_destroynativewindowbuffer) (struct NativeWindowBuffer \*buffer) | 将NativeWindowBuffer对象的引用计数减1，当引用计数为0的时候，该NativeWindowBuffer对象会被析构掉 |
| [OH_NativeWindow_NativeWindowRequestBuffer](#ohnativewindownativewindowrequestbuffer)&nbsp;(struct&nbsp;NativeWindow&nbsp;\*window,&nbsp;struct&nbsp;NativeWindowBuffer&nbsp;\*\*buffer,&nbsp;int&nbsp;\*fenceFd) | 通过NativeWindow对象申请一块NativeWindowBuffer，用以内容生产 | | [OH_NativeWindow_NativeWindowRequestBuffer](#oh_nativewindow_nativewindowrequestbuffer) (struct NativeWindow \*window, struct NativeWindowBuffer \*\*buffer, int \*fenceFd) | 通过NativeWindow对象申请一块NativeWindowBuffer，用以内容生产 |
| [OH_NativeWindow_NativeWindowFlushBuffer](#ohnativewindownativewindowflushbuffer)&nbsp;(struct&nbsp;NativeWindow&nbsp;\*window,&nbsp;struct&nbsp;NativeWindowBuffer&nbsp;\*buffer,&nbsp;int&nbsp;fenceFd,&nbsp;Region&nbsp;region) | 通过NativeWindow将生产好内容的NativeWindowBuffer放回到Buffer队列中，用以内容消费 | | [OH_NativeWindow_NativeWindowFlushBuffer](#oh_nativewindow_nativewindowflushbuffer) (struct NativeWindow \*window, struct NativeWindowBuffer \*buffer, int fenceFd, Region region) | 通过NativeWindow将生产好内容的NativeWindowBuffer放回到Buffer队列中，用以内容消费 |
| [OH_NativeWindow_NativeWindowCancelBuffer](#ohnativewindownativewindowcancelbuffer)&nbsp;(struct&nbsp;NativeWindow&nbsp;\*window,&nbsp;struct&nbsp;NativeWindowBuffer&nbsp;\*buffer) | 通过NativeWindow将之前申请出来的NativeWindowBuffer返还到Buffer队列中，供下次再申请 | | [OH_NativeWindow_NativeWindowCancelBuffer](#oh_nativewindow_nativewindowcancelbuffer) (struct NativeWindow \*window, struct NativeWindowBuffer \*buffer) | 通过NativeWindow将之前申请出来的NativeWindowBuffer返还到Buffer队列中，供下次再申请 |
| [OH_NativeWindow_NativeWindowHandleOpt](#ohnativewindownativewindowhandleopt)&nbsp;(struct&nbsp;NativeWindow&nbsp;\*window,&nbsp;int&nbsp;code,...) | 设置/获取NativeWindow的属性，包括设置/获取宽高、内容格式等 | | [OH_NativeWindow_NativeWindowHandleOpt](#oh_nativewindow_nativewindowhandleopt) (struct NativeWindow \*window, int code,...) | 设置/获取NativeWindow的属性，包括设置/获取宽高、内容格式等 |
| [OH_NativeWindow_GetBufferHandleFromNative](#ohnativewindowgetbufferhandlefromnative)&nbsp;(struct&nbsp;NativeWindowBuffer&nbsp;\*buffer) | 通过NativeWindowBuffer获取该buffer的BufferHandle指针 | | [OH_NativeWindow_GetBufferHandleFromNative](#oh_nativewindow_getbufferhandlefromnative) (struct NativeWindowBuffer \*buffer) | 通过NativeWindowBuffer获取该buffer的BufferHandle指针 |
| [OH_NativeWindow_NativeObjectReference](#ohnativewindownativeobjectreference)&nbsp;(void&nbsp;\*obj) | 增加一个NativeObject的引用计数 | | [OH_NativeWindow_NativeObjectReference](#oh_nativewindow_nativeobjectreference) (void \*obj) | 增加一个NativeObject的引用计数 |
| [OH_NativeWindow_NativeObjectUnreference](#ohnativewindownativeobjectunreference)&nbsp;(void&nbsp;\*obj) | 减少一个NativeObject的引用计数，当引用计数减少为0时，该NativeObject将被析构掉 | | [OH_NativeWindow_NativeObjectUnreference](#oh_nativewindow_nativeobjectunreference) (void \*obj) | 减少一个NativeObject的引用计数，当引用计数减少为0时，该NativeObject将被析构掉 |
| [OH_NativeWindow_GetNativeObjectMagic](#ohnativewindowgetnativeobjectmagic)&nbsp;(void&nbsp;\*obj) | 获取NativeObject的MagicId | | [OH_NativeWindow_GetNativeObjectMagic](#oh_nativewindow_getnativeobjectmagic) (void \*obj) | 获取NativeObject的MagicId |
## 详细描述 ## 详细描述
...@@ -196,7 +196,7 @@ int32_t OH_NativeWindow_GetNativeObjectMagic (void * obj) ...@@ -196,7 +196,7 @@ int32_t OH_NativeWindow_GetNativeObjectMagic (void * obj)
| Name | 描述 | | Name | 描述 |
| -------- | -------- | | -------- | -------- |
| obj | 参数是一个NativeWindow&nbsp;or&nbsp;NativeWindowBuffer的结构体实例的指针 | | obj | 参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针 |
**返回：** **返回：**
...@@ -224,7 +224,7 @@ int32_t OH_NativeWindow_NativeObjectReference (void * obj) ...@@ -224,7 +224,7 @@ int32_t OH_NativeWindow_NativeObjectReference (void * obj)
| Name | 描述 | | Name | 描述 |
| -------- | -------- | | -------- | -------- |
| obj | 参数是一个NativeWindow&nbsp;or&nbsp;NativeWindowBuffer的结构体实例的指针 | | obj | 参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针 |
**返回：** **返回：**
...@@ -252,7 +252,7 @@ int32_t OH_NativeWindow_NativeObjectUnreference (void * obj) ...@@ -252,7 +252,7 @@ int32_t OH_NativeWindow_NativeObjectUnreference (void * obj)
| Name | 描述 | | Name | 描述 |
| -------- | -------- | | -------- | -------- |
| obj | 参数是一个NativeWindow&nbsp;or&nbsp;NativeWindowBuffer的结构体实例的指针 | | obj | 参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针 |
**返回：** **返回：**
......
zh-cn/application-dev/reference/native-apis/_o_h___native_buffer.md
浏览文件 @ 92eb22d4
...@@ -34,13 +34,13 @@ ...@@ -34,13 +34,13 @@
| 函数名称 | 描述 | | 函数名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [OH_NativeBuffer_Alloc](#ohnativebufferalloc)&nbsp;(const&nbsp;[OH_NativeBuffer_Config](_o_h___native_buffer___config.md)&nbsp;\*config) | 通过OH_NativeBuffer_Config创建OH_NativeBuffer实例，每次调用都会产生一个新的OH_NativeBuffer实例 | | [OH_NativeBuffer_Alloc](#oh_nativebuffer_alloc) (const [OH_NativeBuffer_Config](_o_h___native_buffer___config.md) \*config) | 通过OH_NativeBuffer_Config创建OH_NativeBuffer实例，每次调用都会产生一个新的OH_NativeBuffer实例 |
| [OH_NativeBuffer_Reference](#ohnativebufferreference)&nbsp;(OH_NativeBuffer&nbsp;\*buffer) | 将OH_NativeBuffer对象的引用计数加1 | | [OH_NativeBuffer_Reference](#oh_nativebuffer_reference) (OH_NativeBuffer \*buffer) | 将OH_NativeBuffer对象的引用计数加1 |
| [OH_NativeBuffer_Unreference](#ohnativebufferunreference)&nbsp;(OH_NativeBuffer&nbsp;\*buffer) | 将OH_NativeBuffer对象的引用计数减1，当引用计数为0的时候，该NativeBuffer对象会被析构掉 | | [OH_NativeBuffer_Unreference](#oh_nativebuffer_unreference) (OH_NativeBuffer \*buffer) | 将OH_NativeBuffer对象的引用计数减1，当引用计数为0的时候，该NativeBuffer对象会被析构掉 |
| [OH_NativeBuffer_GetConfig](#ohnativebuffergetconfig)&nbsp;(OH_NativeBuffer&nbsp;\*buffer,&nbsp;[OH_NativeBuffer_Config](_o_h___native_buffer___config.md)&nbsp;\*config) | 用于获取OH_NativeBuffer的属性 | | [OH_NativeBuffer_GetConfig](#oh_nativebuffer_getconfig) (OH_NativeBuffer \*buffer, [OH_NativeBuffer_Config](_o_h___native_buffer___config.md) \*config) | 用于获取OH_NativeBuffer的属性 |
| [OH_NativeBuffer_Map](#ohnativebuffermap)&nbsp;(OH_NativeBuffer&nbsp;\*buffer,&nbsp;void&nbsp;\*\*virAddr) | 将OH_NativeBuffer对应的ION内存映射到进程空间 | | [OH_NativeBuffer_Map](#oh_nativebuffer_map) (OH_NativeBuffer \*buffer, void \*\*virAddr) | 将OH_NativeBuffer对应的ION内存映射到进程空间 |
| [OH_NativeBuffer_Unmap](#ohnativebufferunmap)&nbsp;(OH_NativeBuffer&nbsp;\*buffer) | 将OH_NativeBuffer对应的ION内存从进程空间移除 | | [OH_NativeBuffer_Unmap](#oh_nativebuffer_unmap) (OH_NativeBuffer \*buffer) | 将OH_NativeBuffer对应的ION内存从进程空间移除 |
| [OH_NativeBuffer_GetSeqNum](#ohnativebuffergetseqnum)&nbsp;(OH_NativeBuffer&nbsp;\*buffer) | 获取OH_NativeBuffer的序列号 | | [OH_NativeBuffer_GetSeqNum](#oh_nativebuffer_getseqnum) (OH_NativeBuffer \*buffer) | 获取OH_NativeBuffer的序列号 |
## 详细描述 ## 详细描述
......
zh-cn/application-dev/reference/native-apis/_o_h___native_image.md
浏览文件 @ 92eb22d4
...@@ -27,14 +27,14 @@ ...@@ -27,14 +27,14 @@
| 函数名称 | 描述 | | 函数名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [OH_NativeImage_Create](#ohnativeimagecreate) (uint32_t textureId, uint32_t textureTarget) | 创建一个**OH_NativeImage**实例，该实例与OPENGL ES的纹理ID和纹理目标相关联。 | | [OH_NativeImage_Create]( #oh_nativeimage_create) (uint32_t textureId, uint32_t textureTarget) | 创建一个**OH_NativeImage**实例，该实例与OPENGL ES的纹理ID和纹理目标相关联。 |
| [OH_NativeImage_AcquireNativeWindow](#ohnativeimageacquirenativewindow) (OH_NativeImage \*image) | 获取与OH_NativeImage相关联的OHNativeWindow指针. 该OHNativeWindow后续不再需要时需要调用 OH_NativeWindow_DestroyNativeWindow释放。 | | [OH_NativeImage_AcquireNativeWindow]( #oh_nativeimage_acquirenativewindow) (OH_NativeImage \*image) | 获取与OH_NativeImage相关联的OHNativeWindow指针. 该OHNativeWindow后续不再需要时需要调用 OH_NativeWindow_DestroyNativeWindow释放。 |
| [OH_NativeImage_AttachContext](#ohnativeimageattachcontext) (OH_NativeImage \*image, uint32_t textureId) | 将OH_NativeImage实例附加到当前OPENGL ES上下文, 且该OPENGL ES纹理会绑定到 GL_TEXTURE_EXTERNAL_OES, 并通过OH_NativeImage进行更新。 | | [OH_NativeImage_AttachContext]( #oh_nativeimage_attachcontext) (OH_NativeImage \*image, uint32_t textureId) | 将OH_NativeImage实例附加到当前OPENGL ES上下文, 且该OPENGL ES纹理会绑定到 GL_TEXTURE_EXTERNAL_OES, 并通过OH_NativeImage进行更新。 |
| [OH_NativeImage_DetachContext](#ohnativeimagedetachcontext) (OH_NativeImage \*image) | 将OH_NativeImage实例从当前OPENGL ES上下文分离。 | | [OH_NativeImage_DetachContext]( #oh_nativeimage_detachcontext) (OH_NativeImage \*image) | 将OH_NativeImage实例从当前OPENGL ES上下文分离。 |
| [OH_NativeImage_UpdateSurfaceImage](#ohnativeimageupdatesurfaceimage) (OH_NativeImage \*image) | 通过OH_NativeImage获取最新帧更新相关联的OPENGL ES纹理。 | | [OH_NativeImage_UpdateSurfaceImage]( #oh_nativeimage_updatesurfaceimage) (OH_NativeImage \*image) | 通过OH_NativeImage获取最新帧更新相关联的OPENGL ES纹理。 |
| [OH_NativeImage_GetTimestamp](#ohnativeimagegettimestamp) (OH_NativeImage \*image) | 获取最近调用OH_NativeImage_UpdateSurfaceImage的纹理图像的相关时间戳。 | | [OH_NativeImage_GetTimestamp]( #oh_nativeimage_gettimestamp) (OH_NativeImage \*image) | 获取最近调用OH_NativeImage_UpdateSurfaceImage的纹理图像的相关时间戳。 |
| [OH_NativeImage_GetTransformMatrix](#ohnativeimagegettransformmatrix) (OH_NativeImage \*image, float matrix[16]) | 获取最近调用OH_NativeImage_UpdateSurfaceImage的纹理图像的变化矩阵。 | | [OH_NativeImage_GetTransformMatrix]( #oh_nativeimage_gettransformmatrix) (OH_NativeImage \*image, float matrix[16]) | 获取最近调用OH_NativeImage_UpdateSurfaceImage的纹理图像的变化矩阵。 |
| [OH_NativeImage_Destroy](#ohnativeimagedestroy) (OH_NativeImage \*\*image) | 销毁通过OH_NativeImage_Create创建的**OH_NativeImage**实例, 销毁后该 **OH_NativeImage**指针会被赋值为空。 | | [OH_NativeImage_Destroy]( #oh_nativeimage_destroy) (OH_NativeImage \*\*image) | 销毁通过OH_NativeImage_Create创建的**OH_NativeImage**实例, 销毁后该 **OH_NativeImage**指针会被赋值为空。 |
## 详细描述 ## 详细描述
......
zh-cn/application-dev/reference/native-apis/_o_h___native_x_component.md
浏览文件 @ 92eb22d4
...@@ -35,9 +35,9 @@ ...@@ -35,9 +35,9 @@
| 类型定义名称 | 描述 | | 类型定义名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [OH_NativeXComponent](#ohnativexcomponent) | 提供封装的OH_NativeXComponent实例。 | | [OH_NativeXComponent](#oh_nativexcomponent) | 提供封装的OH_NativeXComponent实例。 |
| [OH_NativeXComponent_Callback](#ohnativexcomponentcallback) | 注册surface生命周期和触摸事件回调。 | | [OH_NativeXComponent_Callback](#oh_nativexcomponent_callback) | 注册surface生命周期和触摸事件回调。 |
| [OH_NativeXComponent_MouseEvent_Callback](#ohnativexcomponentmouseeventcallback) | 注册鼠标事件的回调。 | | [OH_NativeXComponent_MouseEvent_Callback](#oh_nativexcomponent_mouseeventcallback) | 注册鼠标事件的回调。 |
### 枚举 ### 枚举
...@@ -45,22 +45,22 @@ ...@@ -45,22 +45,22 @@
| 枚举名称 | 描述 | | 枚举名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| {OH_NATIVEXCOMPONENT_RESULT_SUCCESS = 0, <br>OH_NATIVEXCOMPONENT_RESULT_FAILED = -1, <br/>OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER = -2, <br/>OHOS_IMAGE_RESULT_SUCCESS = 0, <br/>OHOS_IMAGE_RESULT_BAD_PARAMETER = -1 } | [枚举](#anonymous-enum)API访问状态。 | | {OH_NATIVEXCOMPONENT_RESULT_SUCCESS = 0, <br>OH_NATIVEXCOMPONENT_RESULT_FAILED = -1, <br/>OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER = -2, <br/>OHOS_IMAGE_RESULT_SUCCESS = 0, <br/>OHOS_IMAGE_RESULT_BAD_PARAMETER = -1 } | [枚举](#anonymous-enum)API访问状态。 |
| [OH_NativeXComponent_TouchEventType](#ohnativexcomponenttoucheventtype) { <br/>OH_NATIVEXCOMPONENT_DOWN = 0, <br/>OH_NATIVEXCOMPONENT_UP, <br/>OH_NATIVEXCOMPONENT_MOVE, <br/>OH_NATIVEXCOMPONENT_CANCEL,<br/>OH_NATIVEXCOMPONENT_UNKNOWN } | 触摸事件类型。 | | [OH_NativeXComponent_TouchEventType](#oh_nativexcomponent_toucheventtype) { <br/>OH_NATIVEXCOMPONENT_DOWN = 0, <br/>OH_NATIVEXCOMPONENT_UP, <br/>OH_NATIVEXCOMPONENT_MOVE, <br/>OH_NATIVEXCOMPONENT_CANCEL,<br/>OH_NATIVEXCOMPONENT_UNKNOWN } | 触摸事件类型。 |
| [OH_NativeXComponent_MouseEventAction](#ohnativexcomponentmouseeventaction) { <br/>OH_NATIVEXCOMPONENT_MOUSE_NONE = 0, <br/>OH_NATIVEXCOMPONENT_MOUSE_PRESS, <br/>OH_NATIVEXCOMPONENT_MOUSE_RELEASE, <br/>OH_NATIVEXCOMPONENT_MOUSE_MOVE } | 鼠标事件动作。 | | [OH_NativeXComponent_MouseEventAction](#oh_nativexcomponent_mouseeventaction) { <br/>OH_NATIVEXCOMPONENT_MOUSE_NONE = 0, <br/>OH_NATIVEXCOMPONENT_MOUSE_PRESS, <br/>OH_NATIVEXCOMPONENT_MOUSE_RELEASE, <br/>OH_NATIVEXCOMPONENT_MOUSE_MOVE } | 鼠标事件动作。 |
| [OH_NativeXComponent_MouseEventButton](#ohnativexcomponentmouseeventbutton) { <br/>OH_NATIVEXCOMPONENT_NONE_BUTTON = 0, <br/>OH_NATIVEXCOMPONENT_LEFT_BUTTON = 0x01, <br/>OH_NATIVEXCOMPONENT_RIGHT_BUTTON = 0x02, <br/>OH_NATIVEXCOMPONENT_MIDDLE_BUTTON = 0x04, <br/>OH_NATIVEXCOMPONENT_BACK_BUTTON = 0x08, <br/>OH_NATIVEXCOMPONENT_FORWARD_BUTTON = 0x10 } | 鼠标事件按键。 | | [OH_NativeXComponent_MouseEventButton](#oh_nativexcomponent_mouseeventbutton) { <br/>OH_NATIVEXCOMPONENT_NONE_BUTTON = 0, <br/>OH_NATIVEXCOMPONENT_LEFT_BUTTON = 0x01, <br/>OH_NATIVEXCOMPONENT_RIGHT_BUTTON = 0x02, <br/>OH_NATIVEXCOMPONENT_MIDDLE_BUTTON = 0x04, <br/>OH_NATIVEXCOMPONENT_BACK_BUTTON = 0x08, <br/>OH_NATIVEXCOMPONENT_FORWARD_BUTTON = 0x10 } | 鼠标事件按键。 |
### 函数 ### 函数
| 函数名称 | 描述 | | 函数名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [OH_NativeXComponent_GetXComponentId](#ohnativexcomponentgetxcomponentid) ([OH_NativeXComponent](#ohnativexcomponent) \*component, char \*id, uint64_t \*size) | 获取ArkUI XComponent的id。 | | [OH_NativeXComponent_GetXComponentId](#oh_nativexcomponent_getxcomponentid) ([OH_NativeXComponent](#oh_nativexcomponent) \*component, char \*id, uint64_t \*size) | 获取ArkUI XComponent的id。 |
| [OH_NativeXComponent_GetXComponentSize](#ohnativexcomponentgetxcomponentsize) ([OH_NativeXComponent](#ohnativexcomponent) \*component, const void \*window, uint64_t \*width, uint64_t \*height) | 获取ArkUI XComponent持有的surface的大小。 | | [OH_NativeXComponent_GetXComponentSize](#oh_nativexcomponent_getxcomponentsize) ([OH_NativeXComponent](#oh_nativexcomponent) \*component, const void \*window, uint64_t \*width, uint64_t \*height) | 获取ArkUI XComponent持有的surface的大小。 |
| [OH_NativeXComponent_GetXComponentOffset](#ohnativexcomponentgetxcomponentoffset) ([OH_NativeXComponent](#ohnativexcomponent) \*component, const void \*window, double \*x, double \*y) | 获取ArkUI XComponent组件相对屏幕左上顶点的偏移量。 | | [OH_NativeXComponent_GetXComponentOffset](#oh_nativexcomponent_getxcomponentoffset) ([OH_NativeXComponent](#oh_nativexcomponent) \*component, const void \*window, double \*x, double \*y) | 获取ArkUI XComponent组件相对屏幕左上顶点的偏移量。 |
| [OH_NativeXComponent_GetTouchEvent](#ohnativexcomponentgettouchevent) ([OH_NativeXComponent](#ohnativexcomponent) \*component, const void \*window, [OH_NativeXComponent_TouchEvent](_o_h___native_x_component___touch_event.md) \*touchEvent) | 获取ArkUI XComponent调度的触摸事件。 | | [OH_NativeXComponent_GetTouchEvent](#oh_nativexcomponent_gettouchevent) ([OH_NativeXComponent](#oh_nativexcomponent) \*component, const void \*window, [OH_NativeXComponent_TouchEvent](_o_h___native_x_component___touch_event.md) \*touchEvent) | 获取ArkUI XComponent调度的触摸事件。 |
| [OH_NativeXComponent_GetMouseEvent](#ohnativexcomponentgetmouseevent) ([OH_NativeXComponent](#ohnativexcomponent) \*component, const void \*window, [OH_NativeXComponent_MouseEvent](_o_h___native_x_component___mouse_event.md) \*mouseEvent) | 获取ArkUI XComponent调度的鼠标事件 | | [OH_NativeXComponent_GetMouseEvent](#oh_nativexcomponent_getmouseevent) ([OH_NativeXComponent](#oh_nativexcomponent) \*component, const void \*window, [OH_NativeXComponent_MouseEvent](_o_h___native_x_component___mouse_event.md) \*mouseEvent) | 获取ArkUI XComponent调度的鼠标事件 |
| [OH_NativeXComponent_RegisterCallback](#ohnativexcomponentregistercallback) ([OH_NativeXComponent](#ohnativexcomponent) \*component, [OH_NativeXComponent_Callback](_o_h___native_x_component___callback.md) \*callback) | 为此OH_NativeXComponent实例注册回调。 | | [OH_NativeXComponent_RegisterCallback](#oh_nativexcomponent_registercallback) ([OH_NativeXComponent](#oh_nativexcomponent) \*component, [OH_NativeXComponent_Callback](_o_h___native_x_component___callback.md) \*callback) | 为此OH_NativeXComponent实例注册回调。 |
| [OH_NativeXComponent_RegisterMouseEventCallback](#ohnativexcomponentregistermouseeventcallback) ([OH_NativeXComponent](#ohnativexcomponent) \*component, [OH_NativeXComponent_MouseEvent_Callback](_o_h___native_x_component___mouse_event___callback.md) \*callback) | 为此OH_NativeXComponent实例注册鼠标事件回调。 | | [OH_NativeXComponent_RegisterMouseEventCallback](#oh_nativexcomponent_registermouseeventcallback) ([OH_NativeXComponent](#oh_nativexcomponent) \*component, [OH_NativeXComponent_MouseEvent_Callback](_o_h___native_x_component___mouse_event___callback.md) \*callback) | 为此OH_NativeXComponent实例注册鼠标事件回调。 |
### 变量 ### 变量
...@@ -98,12 +98,12 @@ ...@@ -98,12 +98,12 @@
| [OH_NativeXComponent_MouseEvent::timestamp](#timestamp) | 当前鼠标事件的时间戳。 | | [OH_NativeXComponent_MouseEvent::timestamp](#timestamp) | 当前鼠标事件的时间戳。 |
| [OH_NativeXComponent_MouseEvent::action](#action) | 当前鼠标事件动作。 | | [OH_NativeXComponent_MouseEvent::action](#action) | 当前鼠标事件动作。 |
| [OH_NativeXComponent_MouseEvent::button](#button) | 鼠标事件按键。 | | [OH_NativeXComponent_MouseEvent::button](#button) | 鼠标事件按键。 |
| [OH_NativeXComponent_Callback::OnSurfaceCreated](#onsurfacecreated) )([OH_NativeXComponent](#ohnativexcomponent) \*component, void \*window) | 创建surface时调用。 | | [OH_NativeXComponent_Callback::OnSurfaceCreated](#onsurfacecreated) )([OH_NativeXComponent](#oh_nativexcomponent) \*component, void \*window) | 创建surface时调用。 |
| [OH_NativeXComponent_Callback::OnSurfaceChanged](#onsurfacechanged) )([OH_NativeXComponent](#ohnativexcomponent) \*component, void \*window) | 当surface改变时调用。 | | [OH_NativeXComponent_Callback::OnSurfaceChanged](#onsurfacechanged) )([OH_NativeXComponent](#oh_nativexcomponent) \*component, void \*window) | 当surface改变时调用。 |
| [OH_NativeXComponent_Callback::OnSurfaceDestroyed](#onsurfacedestroyed) )([OH_NativeXComponent](#ohnativexcomponent) \*component, void \*window) | 当surface被破坏时调用。 | | [OH_NativeXComponent_Callback::OnSurfaceDestroyed](#onsurfacedestroyed) )([OH_NativeXComponent](#oh_nativexcomponent) \*component, void \*window) | 当surface被破坏时调用。 |
| [OH_NativeXComponent_Callback::DispatchTouchEvent](#dispatchtouchevent) )([OH_NativeXComponent](#ohnativexcomponent) \*component, void \*window) | 当触摸事件被触发时调用。 | | [OH_NativeXComponent_Callback::DispatchTouchEvent](#dispatchtouchevent) )([OH_NativeXComponent](#oh_nativexcomponent) \*component, void \*window) | 当触摸事件被触发时调用。 |
| [OH_NativeXComponent_MouseEvent_Callback::DispatchMouseEvent](#dispatchmouseevent) )([OH_NativeXComponent](#ohnativexcomponent) \*component, void \*window) | 当鼠标事件被触发时调用。 | | [OH_NativeXComponent_MouseEvent_Callback::DispatchMouseEvent](#dispatchmouseevent) )([OH_NativeXComponent](#oh_nativexcomponent) \*component, void \*window) | 当鼠标事件被触发时调用。 |
| [OH_NativeXComponent_MouseEvent_Callback::DispatchHoverEvent](#dispatchhoverevent) )([OH_NativeXComponent](#ohnativexcomponent) \*component, bool isHover) | 当悬停事件被触发时调用。 | | [OH_NativeXComponent_MouseEvent_Callback::DispatchHoverEvent](#dispatchhoverevent) )([OH_NativeXComponent](#oh_nativexcomponent) \*component, bool isHover) | 当悬停事件被触发时调用。 |
## 详细描述 ## 详细描述
......
zh-cn/application-dev/reference/native-apis/_o_h___native_x_component___touch_event.md
浏览文件 @ 92eb22d4
...@@ -21,15 +21,15 @@ ...@@ -21,15 +21,15 @@
| 成员变量名称 | 描述 | | 成员变量名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [id](_o_h___native_x_component.md#id-22)&nbsp;=&nbsp;0 | 手指的唯一标识符。 | | [id](_o_h___native_x_component.md#id-22) = 0 | 手指的唯一标识符。 |
| [screenX](_o_h___native_x_component.md#screenx-23)&nbsp;=&nbsp;0.0 | 触摸点相对于屏幕左边缘的x坐标。 | | [screenX](_o_h___native_x_component.md#screenx-23) = 0.0 | 触摸点相对于屏幕左边缘的x坐标。 |
| [screenY](_o_h___native_x_component.md#screeny-23)&nbsp;=&nbsp;0.0 | 触摸点相对于屏幕上边缘的y坐标。 | | [screenY](_o_h___native_x_component.md#screeny-23) = 0.0 | 触摸点相对于屏幕上边缘的y坐标。 |
| [x](_o_h___native_x_component.md#x-23)&nbsp;=&nbsp;0.0 | 触摸点相对于XComponent组件左边缘的x坐标。 | | [x](_o_h___native_x_component.md#x-23) = 0.0 | 触摸点相对于XComponent组件左边缘的x坐标。 |
| [y](_o_h___native_x_component.md#y-23)&nbsp;=&nbsp;0.0 | 触摸点相对于XComponent组件上边缘的y坐标。 | | [y](_o_h___native_x_component.md#y-23) = 0.0 | 触摸点相对于XComponent组件上边缘的y坐标。 |
| [type](_o_h___native_x_component.md#type-22)&nbsp;=&nbsp;[OH_NativeXComponent_TouchEventType::OH_NATIVEXCOMPONENT_UNKNOWN](_o_h___native_x_component.md#gga0a8c68dd460d7e801e7c0ff771f09182aff39d23c1412b3b110a19df4893651d3) | 触摸事件的触摸类型。 | | [type](_o_h___native_x_component.md#type-22) = OH_NativeXComponent_TouchEventType::OH_NATIVEXCOMPONENT_UNKNOWN | 触摸事件的触摸类型。 |
| [size](_o_h___native_x_component.md#size-22)&nbsp;=&nbsp;0.0 | 指垫和屏幕之间的接触面积。 | | [size](_o_h___native_x_component.md#size-22) = 0.0 | 指垫和屏幕之间的接触面积。 |
| [force](_o_h___native_x_component.md#force-22)&nbsp;=&nbsp;0.0 | 当前触摸事件的压力。 | | [force](_o_h___native_x_component.md#force-22) = 0.0 | 当前触摸事件的压力。 |
| [deviceId](_o_h___native_x_component.md#deviceid)&nbsp;=&nbsp;0 | 产生当前触摸事件的设备的ID。 | | [deviceId](_o_h___native_x_component.md#deviceid) = 0 | 产生当前触摸事件的设备的ID。 |
| [timeStamp](_o_h___native_x_component.md#timestamp-22)&nbsp;=&nbsp;0 | 当前触摸事件的时间戳。 | | [timeStamp](_o_h___native_x_component.md#timestamp-22) = 0 | 当前触摸事件的时间戳。 |
| [touchPoints](_o_h___native_x_component.md#touchpoints)&nbsp;[OH_MAX_TOUCH_POINTS_NUMBER] | 当前触摸点的数组。 | | [touchPoints](_o_h___native_x_component.md#touchpoints) [OH_MAX_TOUCH_POINTS_NUMBER] | 当前触摸点的数组。 |
| [numPoints](_o_h___native_x_component.md#numpoints)&nbsp;=&nbsp;0 | 当前接触点的数量。 | | [numPoints](_o_h___native_x_component.md#numpoints) = 0 | 当前接触点的数量。 |
zh-cn/application-dev/reference/native-apis/_o_h___native_x_component___touch_point.md
浏览文件 @ 92eb22d4
...@@ -21,13 +21,13 @@ ...@@ -21,13 +21,13 @@
| 成员变量名称 | 描述 | | 成员变量名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [id](_o_h___native_x_component.md#id-12)&nbsp;=&nbsp;0 | 手指的唯一标识符。 | | [id](_o_h___native_x_component.md#id-12) = 0 | 手指的唯一标识符。 |
| [screenX](_o_h___native_x_component.md#screenx-13)&nbsp;=&nbsp;0.0 | 触摸点相对于屏幕左边缘的x坐标。 | | [screenX](_o_h___native_x_component.md#screenx-13) = 0.0 | 触摸点相对于屏幕左边缘的x坐标。 |
| [screenY](_o_h___native_x_component.md#screeny-13)&nbsp;=&nbsp;0.0 | 触摸点相对于屏幕上边缘的y坐标。 | | [screenY](_o_h___native_x_component.md#screeny-13) = 0.0 | 触摸点相对于屏幕上边缘的y坐标。 |
| [x](_o_h___native_x_component.md#x-13)&nbsp;=&nbsp;0.0 | 触摸点相对于XComponent组件左边缘的x坐标。 | | [x](_o_h___native_x_component.md#x-13) = 0.0 | 触摸点相对于XComponent组件左边缘的x坐标。 |
| [y](_o_h___native_x_component.md#y-13)&nbsp;=&nbsp;0.0 | 触摸点相对于XComponent组件上边缘的y坐标。 | | [y](_o_h___native_x_component.md#y-13) = 0.0 | 触摸点相对于XComponent组件上边缘的y坐标。 |
| [type](_o_h___native_x_component.md#type-12)&nbsp;=&nbsp;[OH_NativeXComponent_TouchEventType::OH_NATIVEXCOMPONENT_UNKNOWN](_o_h___native_x_component.md#gga0a8c68dd460d7e801e7c0ff771f09182aff39d23c1412b3b110a19df4893651d3) | 触摸事件的触摸类型。 | | [type](_o_h___native_x_component.md#type-12) = OH_NativeXComponent_TouchEventType::OH_NATIVEXCOMPONENT_UNKNOWN | 触摸事件的触摸类型。 |
| [size](_o_h___native_x_component.md#size-12)&nbsp;=&nbsp;0.0 | 指垫和屏幕之间的接触面积。 | | [size](_o_h___native_x_component.md#size-12) = 0.0 | 指垫和屏幕之间的接触面积。 |
| [force](_o_h___native_x_component.md#force-12)&nbsp;=&nbsp;0.0 | 当前触摸事件的压力。 | | [force](_o_h___native_x_component.md#force-12) = 0.0 | 当前触摸事件的压力。 |
| [timeStamp](_o_h___native_x_component.md#timestamp-12)&nbsp;=&nbsp;0 | 当前触摸事件的时间戳。 | | [timeStamp](_o_h___native_x_component.md#timestamp-12) = 0 | 当前触摸事件的时间戳。 |
| [isPressed](_o_h___native_x_component.md#ispressed)&nbsp;=&nbsp;false | 当前点是否被按下。 | | [isPressed](_o_h___native_x_component.md#ispressed) = false | 当前点是否被按下。 |
zh-cn/application-dev/reference/native-apis/image.md
浏览文件 @ 92eb22d4
...@@ -42,9 +42,9 @@ ...@@ -42,9 +42,9 @@
| 函数名称 | 描述 | | 函数名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [OH_GetImageInfo](#ohgetimageinfo) (napi_env env, napi_value value, [OhosPixelMapInfo](_ohos_pixel_map_info.md) \*info) | 获取 **PixelMap** 的信息，并记录信息到[OhosPixelMapInfo](_ohos_pixel_map_info.md)结构中。 | | [OH_GetImageInfo](#oh_getimageinfo) (napi_env env, napi_value value, [OhosPixelMapInfo](_ohos_pixel_map_info.md) \*info) | 获取 **PixelMap** 的信息，并记录信息到[OhosPixelMapInfo](_ohos_pixel_map_info.md)结构中。 |
| [OH_AccessPixels](#ohaccesspixels) (napi_env env, napi_value value, void \*\*addrPtr) | 获取**PixelMap**对象数据的内存地址，并锁定该内存。 | | [OH_AccessPixels](#oh_accesspixels) (napi_env env, napi_value value, void \*\*addrPtr) | 获取**PixelMap**对象数据的内存地址，并锁定该内存。 |
| [OH_UnAccessPixels](#ohunaccesspixels) (napi_env env, napi_value value) | 释放**PixelMap**对象数据的内存锁, 用于匹配方法[OH_AccessPixels](#ohaccesspixels)。 | | [OH_UnAccessPixels](#oh_unaccesspixels) (napi_env env, napi_value value) | 释放**PixelMap**对象数据的内存锁, 用于匹配方法[OH_AccessPixels](#oh_accesspixels)。 |
## 详细描述 ## 详细描述
...@@ -113,7 +113,7 @@ int32_t OH_AccessPixels (napi_env env, napi_value value, void ** addrPtr ) ...@@ -113,7 +113,7 @@ int32_t OH_AccessPixels (napi_env env, napi_value value, void ** addrPtr )
获取**PixelMap**对象数据的内存地址，并锁定该内存。 获取**PixelMap**对象数据的内存地址，并锁定该内存。
函数执行成功后，**\*addrPtr**就是获取的待访问的内存地址。访问操作完成后,必须要使用[OH_UnAccessPixels](#ohunaccesspixels)来释放锁, 否则的话资源无法被释放。待解锁后，内存地址就不可以再被访问和操作。 函数执行成功后，**\*addrPtr**就是获取的待访问的内存地址。访问操作完成后,必须要使用[OH_UnAccessPixels](#oh_unaccesspixels)来释放锁, 否则的话资源无法被释放。待解锁后，内存地址就不可以再被访问和操作。
**参数：** **参数：**
...@@ -125,7 +125,7 @@ int32_t OH_AccessPixels (napi_env env, napi_value value, void ** addrPtr ) ...@@ -125,7 +125,7 @@ int32_t OH_AccessPixels (napi_env env, napi_value value, void ** addrPtr )
**参见：** **参见：**
[OH_UnAccessPixels](#ohunaccesspixels) [OH_UnAccessPixels](#oh_unaccesspixels)
**返回：** **返回：**
...@@ -177,7 +177,7 @@ int32_t OH_UnAccessPixels (napi_env env, napi_value value ) ...@@ -177,7 +177,7 @@ int32_t OH_UnAccessPixels (napi_env env, napi_value value )
**描述：** **描述：**
释放**PixelMap**对象数据的内存锁, 用于匹配方法[OH_AccessPixels](#ohaccesspixels)。 释放**PixelMap**对象数据的内存锁, 用于匹配方法[OH_AccessPixels](#oh_accesspixels)。
**参数：** **参数：**
......
zh-cn/application-dev/reference/native-apis/rawfile.md
浏览文件 @ 92eb22d4
...@@ -38,27 +38,27 @@ ...@@ -38,27 +38,27 @@
| -------- | -------- | | -------- | -------- |
| [RawDir](#rawdir) | 提供对rawfile目录的访问。 | | [RawDir](#rawdir) | 提供对rawfile目录的访问。 |
| [RawFile](#rawfile) | 提供对rawfile的访问功能。 | | [RawFile](#rawfile) | 提供对rawfile的访问功能。 |
| [NativeResourceManager](#nativeresourcemanager) | 代表resource&nbsp;manager。 | | [NativeResourceManager](#nativeresourcemanager) | 代表resource manager。 |
### 函数 ### 函数
| 函数名称 | 描述 | | 函数名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [OH_ResourceManager_GetRawFileName](#ohresourcemanagergetrawfilename)&nbsp;([RawDir](#rawdir)&nbsp;\*rawDir,&nbsp;int&nbsp;index) | 通过索引获取rawfile文件名称。 | | [OH_ResourceManager_GetRawFileName](#oh_resourcemanager_getrawfilename) ([RawDir](#rawdir) \*rawDir, int index) | 通过索引获取rawfile文件名称。 |
| [OH_ResourceManager_GetRawFileCount](#ohresourcemanagergetrawfilecount)&nbsp;([RawDir](#rawdir)&nbsp;\*rawDir) | 获取[RawDir](#rawdir)中的rawfile数量。 | | [OH_ResourceManager_GetRawFileCount](#oh_resourcemanager_getrawfilecount) ([RawDir](#rawdir) \*rawDir) | 获取[RawDir](#rawdir)中的rawfile数量。 |
| [OH_ResourceManager_CloseRawDir](#ohresourcemanagercloserawdir)&nbsp;([RawDir](#rawdir)&nbsp;\*rawDir) | 关闭已打开的[RawDir](#rawdir)并释放所有相关联资源。 | | [OH_ResourceManager_CloseRawDir](#oh_resourcemanager_closerawdir) ([RawDir](#rawdir) \*rawDir) | 关闭已打开的[RawDir](#rawdir)并释放所有相关联资源。 |
| [OH_ResourceManager_ReadRawFile](#ohresourcemanagerreadrawfile)&nbsp;(const&nbsp;[RawFile](#rawfile)&nbsp;\*rawFile,&nbsp;void&nbsp;\*buf,&nbsp;size_t&nbsp;length) | 读取rawfile。 | | [OH_ResourceManager_ReadRawFile](#oh_resourcemanager_readrawfile) (const [RawFile](#rawfile) \*rawFile, void \*buf, size_t length) | 读取rawfile。 |
| [OH_ResourceManager_SeekRawFile](#ohresourcemanagerseekrawfile)&nbsp;(const&nbsp;[RawFile](#rawfile)&nbsp;\*rawFile,&nbsp;long&nbsp;offset,&nbsp;int&nbsp;whence) | 基于指定的offset，在rawfile文件内搜索读写数据的位置。 | | [OH_ResourceManager_SeekRawFile](#oh_resourcemanager_seekrawfile) (const [RawFile](#rawfile) \*rawFile, long offset, int whence) | 基于指定的offset，在rawfile文件内搜索读写数据的位置。 |
| [OH_ResourceManager_GetRawFileSize](#ohresourcemanagergetrawfilesize)&nbsp;([RawFile](#rawfile)&nbsp;\*rawFile) | 获取rawfile长度，单位为int32_t。 | | [OH_ResourceManager_GetRawFileSize](#oh_resourcemanager_getrawfilesize) ([RawFile](#rawfile) \*rawFile) | 获取rawfile长度，单位为int32_t。 |
| [OH_ResourceManager_CloseRawFile](#ohresourcemanagercloserawfile)&nbsp;([RawFile](#rawfile)&nbsp;\*rawFile) | 关闭已打开的[RawFile](#rawfile)&nbsp;以及释放所有相关联资源。 | | [OH_ResourceManager_CloseRawFile](#oh_resourcemanager_closerawfile) ([RawFile](#rawfile) \*rawFile) | 关闭已打开的[RawFile](#rawfile) 以及释放所有相关联资源。 |
| [OH_ResourceManager_GetRawFileOffset](#ohresourcemanagergetrawfileoffset)&nbsp;(const&nbsp;[RawFile](#rawfile)&nbsp;\*rawFile) | 获取rawfile当前的offset，单位为int32_t。 | | [OH_ResourceManager_GetRawFileOffset](#oh_resourcemanager_getrawfileoffset) (const [RawFile](#rawfile) \*rawFile) | 获取rawfile当前的offset，单位为int32_t。 |
| [OH_ResourceManager_GetRawFileDescriptor](#ohresourcemanagergetrawfiledescriptor)&nbsp;(const&nbsp;[RawFile](#rawfile)&nbsp;\*rawFile,&nbsp;[RawFileDescriptor](_raw_file_descriptor.md)&nbsp;&amp;descriptor) | 基于offset(单位为int32_t)和文件长度打开rawfile，并获取rawfile文件描述符。 | | [OH_ResourceManager_GetRawFileDescriptor](#oh_resourcemanager_getrawfiledescriptor) (const [RawFile](#rawfile) \*rawFile, [RawFileDescriptor](_raw_file_descriptor.md) &amp;descriptor) | 基于offset(单位为int32_t)和文件长度打开rawfile，并获取rawfile文件描述符。 |
| [OH_ResourceManager_ReleaseRawFileDescriptor](#ohresourcemanagerreleaserawfiledescriptor)&nbsp;(const&nbsp;[RawFileDescriptor](_raw_file_descriptor.md)&nbsp;&amp;descriptor) | 关闭rawfile文件描述符。 | | [OH_ResourceManager_ReleaseRawFileDescriptor](#oh_resourcemanager_releaserawfiledescriptor) (const [RawFileDescriptor](_raw_file_descriptor.md) &amp;descriptor) | 关闭rawfile文件描述符。 |
| [OH_ResourceManager_InitNativeResourceManager](#ohresourcemanagerinitnativeresourcemanager)&nbsp;(napi_env&nbsp;env,&nbsp;napi_value&nbsp;jsResMgr) | 基于JavaScipt&nbsp;resource&nbsp;manager获取native&nbsp;resource&nbsp;manager。 | | [OH_ResourceManager_InitNativeResourceManager](#oh_resourcemanager_initnativeresourcemanager) (napi_env env, napi_value jsResMgr) | 基于JavaScipt resource manager获取native resource manager。 |
| [OH_ResourceManager_ReleaseNativeResourceManager](#ohresourcemanagerreleasenativeresourcemanager)&nbsp;([NativeResourceManager](#nativeresourcemanager)&nbsp;\*resMgr) | 释放native&nbsp;resource&nbsp;manager。 | | [OH_ResourceManager_ReleaseNativeResourceManager](#oh_resourcemanager_releasenativeresourcemanager) ([NativeResourceManager](#nativeresourcemanager) \*resMgr) | 释放native resource manager。 |
| [OH_ResourceManager_OpenRawDir](#ohresourcemanageropenrawdir)&nbsp;(const&nbsp;[NativeResourceManager](#nativeresourcemanager)&nbsp;\*mgr,&nbsp;const&nbsp;char&nbsp;\*dirName) | 打开rawfile目录。 | | [OH_ResourceManager_OpenRawDir](#oh_resourcemanager_openrawdir) (const [NativeResourceManager](#nativeresourcemanager) \*mgr, const char \*dirName) | 打开rawfile目录。 |
| [OH_ResourceManager_OpenRawFile](#ohresourcemanageropenrawfile)&nbsp;(const&nbsp;[NativeResourceManager](#nativeresourcemanager)&nbsp;\*mgr,&nbsp;const&nbsp;char&nbsp;\*fileName) | 打开rawfile文件。 | | [OH_ResourceManager_OpenRawFile](#oh_resourcemanager_openrawfile) (const [NativeResourceManager](#nativeresourcemanager) \*mgr, const char \*fileName) | 打开rawfile文件。 |
## 详细描述 ## 详细描述
...@@ -78,7 +78,7 @@ typedef struct NativeResourceManager NativeResourceManager ...@@ -78,7 +78,7 @@ typedef struct NativeResourceManager NativeResourceManager
代表resource manager。 代表resource manager。
此类封装了JavaScript resource manager的native实现 **ResourceManager**指针可以通过调用[OH_ResourceManager_InitNativeResourceManager](#ohresourcemanagerinitnativeresourcemanager)方法获取 此类封装了JavaScript resource manager的native实现 **ResourceManager**指针可以通过调用[OH_ResourceManager_InitNativeResourceManager](#oh_resourcemanager_initnativeresourcemanager)方法获取
**自从：** **自从：**
...@@ -139,7 +139,7 @@ void OH_ResourceManager_CloseRawDir (RawDir * rawDir) ...@@ -139,7 +139,7 @@ void OH_ResourceManager_CloseRawDir (RawDir * rawDir)
**参见：** **参见：**
[OH_ResourceManager_OpenRawDir](#ohresourcemanageropenrawdir) [OH_ResourceManager_OpenRawDir](#oh_resourcemanager_openrawdir)
**自从：** **自从：**
...@@ -165,7 +165,7 @@ void OH_ResourceManager_CloseRawFile (RawFile * rawFile) ...@@ -165,7 +165,7 @@ void OH_ResourceManager_CloseRawFile (RawFile * rawFile)
**参见：** **参见：**
[OH_ResourceManager_OpenRawFile](#ohresourcemanageropenrawfile) [OH_ResourceManager_OpenRawFile](#oh_resourcemanager_openrawfile)
**自从：** **自从：**
...@@ -183,7 +183,7 @@ int OH_ResourceManager_GetRawFileCount (RawDir * rawDir) ...@@ -183,7 +183,7 @@ int OH_ResourceManager_GetRawFileCount (RawDir * rawDir)
获取[RawDir](#rawdir)中的rawfile数量。 获取[RawDir](#rawdir)中的rawfile数量。
通过此方法可以获取[OH_ResourceManager_GetRawFileName](#ohresourcemanagergetrawfilename)中可用的索引。 通过此方法可以获取[OH_ResourceManager_GetRawFileName](#oh_resourcemanager_getrawfilename)中可用的索引。
**参数：** **参数：**
...@@ -193,7 +193,7 @@ int OH_ResourceManager_GetRawFileCount (RawDir * rawDir) ...@@ -193,7 +193,7 @@ int OH_ResourceManager_GetRawFileCount (RawDir * rawDir)
**参见：** **参见：**
[OH_ResourceManager_GetRawFileName](#ohresourcemanagergetrawfilename) [OH_ResourceManager_GetRawFileName](#oh_resourcemanager_getrawfilename)
**自从：** **自从：**
...@@ -251,11 +251,11 @@ const char* OH_ResourceManager_GetRawFileName (RawDir * rawDir, int index ) ...@@ -251,11 +251,11 @@ const char* OH_ResourceManager_GetRawFileName (RawDir * rawDir, int index )
**返回：** **返回：**
通过索引返回文件名称，此返回值可以作为[OH_ResourceManager_OpenRawFile](#ohresourcemanageropenrawfile)的输入参数， 如果遍历完所有文件仍未找到，则返回**NULL**。 通过索引返回文件名称，此返回值可以作为[OH_ResourceManager_OpenRawFile](#oh_resourcemanager_openrawfile)的输入参数， 如果遍历完所有文件仍未找到，则返回**NULL**。
**参见：** **参见：**
[OH_ResourceManager_OpenRawFile](#ohresourcemanageropenrawfile) [OH_ResourceManager_OpenRawFile](#oh_resourcemanager_openrawfile)
**自从：** **自从：**
...@@ -333,8 +333,8 @@ NativeResourceManager* OH_ResourceManager_InitNativeResourceManager (napi_env en ...@@ -333,8 +333,8 @@ NativeResourceManager* OH_ResourceManager_InitNativeResourceManager (napi_env en
| Name | 描述 | | Name | 描述 |
| -------- | -------- | | -------- | -------- |
| env | 表示JavaScipt&nbsp;Native&nbsp;Interface&nbsp;(napi)环境指针。 | | env | 表示JavaScipt Native Interface (napi)环境指针。 |
| jsResMgr | 表示JavaScipt&nbsp;resource&nbsp;manager。 | | jsResMgr | 表示JavaScipt resource manager。 |
**返回：** **返回：**
...@@ -362,18 +362,18 @@ RawDir* OH_ResourceManager_OpenRawDir (const NativeResourceManager * mgr, const ...@@ -362,18 +362,18 @@ RawDir* OH_ResourceManager_OpenRawDir (const NativeResourceManager * mgr, const
| Name | 描述 | | Name | 描述 |
| -------- | -------- | | -------- | -------- |
| mgr | 表示指向[NativeResourceManager](#nativeresourcemanager)的指针，此指针是通过调用&nbsp;[OH_ResourceManager_InitNativeResourceManager](#ohresourcemanagerinitnativeresourcemanager)方法获取的。 | | mgr | 表示指向[NativeResourceManager](#nativeresourcemanager)的指针，此指针是通过调用 [OH_ResourceManager_InitNativeResourceManager](#oh_resourcemanager_initnativeresourcemanager)方法获取的。 |
| dirName | 表示要打开的rawfile目录名称，当传递一个空字符串时表示打开rawfile根目录。 | | dirName | 表示要打开的rawfile目录名称，当传递一个空字符串时表示打开rawfile根目录。 |
**返回：** **返回：**
返回[RawDir](#rawdir)指针。使用完此指针后，调用[OH_ResourceManager_CloseRawDir](#ohresourcemanagercloserawdir)释放。 返回[RawDir](#rawdir)指针。使用完此指针后，调用[OH_ResourceManager_CloseRawDir](#oh_resourcemanager_closerawdir)释放。
**参见：** **参见：**
[OH_ResourceManager_InitNativeResourceManager](#ohresourcemanagerinitnativeresourcemanager) [OH_ResourceManager_InitNativeResourceManager](#oh_resourcemanager_initnativeresourcemanager)
[OH_ResourceManager_CloseRawDir](#ohresourcemanagercloserawdir) [OH_ResourceManager_CloseRawDir](#oh_resourcemanager_closerawdir)
**自从：** **自从：**
...@@ -397,18 +397,18 @@ RawFile* OH_ResourceManager_OpenRawFile (const NativeResourceManager * mgr, cons ...@@ -397,18 +397,18 @@ RawFile* OH_ResourceManager_OpenRawFile (const NativeResourceManager * mgr, cons
| Name | 描述 | | Name | 描述 |
| -------- | -------- | | -------- | -------- |
| mgr | 表示指向[NativeResourceManager](#nativeresourcemanager)的指针，此指针是通过调用&nbsp;[OH_ResourceManager_InitNativeResourceManager](#ohresourcemanagerinitnativeresourcemanager)方法获取的。 | | mgr | 表示指向[NativeResourceManager](#nativeresourcemanager)的指针，此指针是通过调用 [OH_ResourceManager_InitNativeResourceManager](#oh_resourcemanager_initnativeresourcemanager)方法获取的。 |
| fileName | 表示基于rawfile根目录的相对路径下的文件名称。 | | fileName | 表示基于rawfile根目录的相对路径下的文件名称。 |
**返回：** **返回：**
返回[RawFile](#rawfile)指针。当使用完此指针，调用[OH_ResourceManager_CloseRawFile](#ohresourcemanagercloserawfile)释放。 返回[RawFile](#rawfile)指针。当使用完此指针，调用[OH_ResourceManager_CloseRawFile](#oh_resourcemanager_closerawfile)释放。
**参见：** **参见：**
[OH_ResourceManager_InitNativeResourceManager](#ohresourcemanagerinitnativeresourcemanager) [OH_ResourceManager_InitNativeResourceManager](#oh_resourcemanager_initnativeresourcemanager)
[OH_ResourceManager_CloseRawFile](#ohresourcemanagercloserawfile) [OH_ResourceManager_CloseRawFile](#oh_resourcemanager_closerawfile)
**自从：** **自从：**
...@@ -512,7 +512,7 @@ int OH_ResourceManager_SeekRawFile (const RawFile * rawFile, long offset, int wh ...@@ -512,7 +512,7 @@ int OH_ResourceManager_SeekRawFile (const RawFile * rawFile, long offset, int wh
| -------- | -------- | | -------- | -------- |
| rawFile | 表示指向[RawFile](#rawfile)的指针。 | | rawFile | 表示指向[RawFile](#rawfile)的指针。 |
| offset | 表示指定的offset。 | | offset | 表示指定的offset。 |
| whence | 读写位置，有以下场景:<br/>**0**:&nbsp;读写位置为**offset**<br/>**1**:&nbsp;读写位置为当前位置加上**offset2**:&nbsp;读写位置为文件末尾(EOF)加上**offset**。 | | whence | 读写位置，有以下场景:<br/>**0**: 读写位置为**offset**<br/>**1**: 读写位置为当前位置加上**offset2**: 读写位置为文件末尾(EOF)加上**offset**。 |
**返回：** **返回：**
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或