diff --git a/README.en.md b/README.en.md index 73a72a9ae9ff4715fefc7af9456066b05f9ccf5b..ab214902e9a41188f3e55df269fbcd34c891069a 100644 --- a/README.en.md +++ b/README.en.md @@ -6,11 +6,10 @@ The XComponent is frequently used for displaying camera preview streams and rend ### Preview -| Home page | Rotated drawing | -|:-------------------------------------------------------------------------------------:|:-------------------------------------:| +| Home page | Rotated drawing | +|:------------------------------------:|:-------------------------------------:| | ![](screenshots/device/index.en.png) | ![](screenshots/device/rotate.en.png) | - ### How to Use The app's UI demonstrates the use of the XComponent and employs OpenGL (OpenGL ES) standard APIs to render a 3D graphic (tetrahedron), with a simple linear light source for the 3D illumination. You can swipe across the screen to rotate the tetrahedron. The primary method for updating the 3D graphic's rotation angle is through the NAPI interface. @@ -59,18 +58,18 @@ For details about the source code, see [napi_manager.cpp](entry/src/main/cpp/nap Native XComponent functions are as follows: -| Name | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------- | -| OH_NativeXComponent_GetXComponentId(OH_NativeXComponent *component, char *id, uint64_t *size) | Obtain the ID of the ArkUI XComponent. | -| OH_NativeXComponent_GetXComponentSize(OH_NativeXComponent *component, const void *window, uint64_t *width, uint64_t *height) | Obtains the size of the surface held by the ArkUI XComponent. | -| OH_NativeXComponent_GetXComponentOffset(OH_NativeXComponent *component, const void *window, double *x, double *y) | Obtains the offset of the ArkUI XComponent relative to the upper left vertex of the screen.| -| OH_NativeXComponent_GetTouchEvent(OH_NativeXComponent *component, const void *window, OH_NativeXComponent_TouchEvent *touchEvent) | Obtains the touch event scheduled by the ArkUI XComponent. | -| OH_NativeXComponent_GetTouchPointToolType(OH_NativeXComponent *component, uint32_t pointIndex, OH_NativeXComponent_TouchPointToolType *toolType) | Obtains the ArkUI XComponent touch point tool type. | -| OH_NativeXComponent_GetTouchPointTiltX(OH_NativeXComponent *component, uint32_t pointIndex, float *tiltX) | Obtains the angle between the Y-Z plane of the ArkUI XComponent touch point and the x-axis. | -| OH_NativeXComponent_GetTouchPointTiltY(OH_NativeXComponent *component, uint32_t pointIndex, float *tiltY) | Obtains the angle between the X-Z plane of the ArkUI XComponent touch point and the y-axis. | -| OH_NativeXComponent_GetMouseEvent(OH_NativeXComponent *component, const void *window, OH_NativeXComponent_MouseEvent *mouseEvent) | Obtains the mouse event scheduled by ArkUI XComponent. | -| OH_NativeXComponent_RegisterCallback(OH_NativeXComponent *component, OH_NativeXComponent_Callback *callback) | Registers a callback for this instance. | -| OH_NativeXComponent_RegisterMouseEventCallback(OH_NativeXComponent *component, OH_NativeXComponent_MouseEvent_Callback *callback) | Registers a mouse event callback for this instance. | +| Name | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | +| OH_NativeXComponent_GetXComponentId(OH_NativeXComponent *component, char *id, uint64_t *size) | Obtain the ID of the ArkUI XComponent. | +| OH_NativeXComponent_GetXComponentSize(OH_NativeXComponent *component, const void *window, uint64_t *width, uint64_t *height) | Obtains the size of the surface held by the ArkUI XComponent. | +| OH_NativeXComponent_GetXComponentOffset(OH_NativeXComponent *component, const void *window, double *x, double *y) | Obtains the offset of the ArkUI XComponent relative to the upper left vertex of the screen. | +| OH_NativeXComponent_GetTouchEvent(OH_NativeXComponent *component, const void *window, OH_NativeXComponent_TouchEvent *touchEvent) | Obtains the touch event scheduled by the ArkUI XComponent. | +| OH_NativeXComponent_GetTouchPointToolType(OH_NativeXComponent *component, uint32_t pointIndex, OH_NativeXComponent_TouchPointToolType *toolType) | Obtains the ArkUI XComponent touch point tool type. | +| OH_NativeXComponent_GetTouchPointTiltX(OH_NativeXComponent *component, uint32_t pointIndex, float *tiltX) | Obtains the angle between the Y-Z plane of the ArkUI XComponent touch point and the x-axis. | +| OH_NativeXComponent_GetTouchPointTiltY(OH_NativeXComponent *component, uint32_t pointIndex, float *tiltY) | Obtains the angle between the X-Z plane of the ArkUI XComponent touch point and the y-axis. | +| OH_NativeXComponent_GetMouseEvent(OH_NativeXComponent *component, const void *window, OH_NativeXComponent_MouseEvent *mouseEvent) | Obtains the mouse event scheduled by ArkUI XComponent. | +| OH_NativeXComponent_RegisterCallback(OH_NativeXComponent *component, OH_NativeXComponent_Callback *callback) | Registers a callback for this instance. | +| OH_NativeXComponent_RegisterMouseEventCallback(OH_NativeXComponent *component, OH_NativeXComponent_MouseEvent_Callback *callback) | Registers a mouse event callback for this instance. | ### Required Permissions @@ -82,10 +81,10 @@ N/A ### Constraints -1. The sample app is supported only on Huawei phones running the standard system. +1. The sample is only supported on Huawei phones with standard systems. -2. The HarmonyOS version must be HarmonyOS NEXT Developer Beta1 or later. +2. The HarmonyOS version must be HarmonyOS 5.0.0 Release or later. -3. The DevEco Studio version must be DevEco Studio NEXT Developer Beta1 or later. +3. The DevEco Studio version must be DevEco Studio 5.0.0 Release or later. -4. The HarmonyOS SDK version must be HarmonyOS NEXT Developer Beta1 or later. +4. The HarmonyOS SDK version must be HarmonyOS 5.0.0 Release SDK or later. diff --git a/README.md b/README.md index ab43a87a7e441ccc1e5a1214dcdf59ed6ddc91ee..4d944b4cabc2dd2c53b9e2e9a7a52ce5112a3f44 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,10 @@ XComponent控件常用于相机预览流的显示和游戏画面的绘制,在Har ### 效果预览 -| 首页 | 滑动屏幕旋转变换 | -|:--------------------------------------:|:----------------------------------------:| +| 首页 | 滑动屏幕旋转变换 | +|:-----------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------:| | index | rotate | - 使用说明 应用界面中展示了XComponent相关控件的使用，及采用OpenGL (OpenGL ES)相关标准API绘制3D图形（三棱锥，3D渲染的光源用的是简单的线性光源）。此外，可在屏幕触摸滑动，以使三棱锥进行旋转，其中主要采用了napi接口来更新3D图形的旋转角度。 @@ -65,7 +64,7 @@ Native XComponent相关函数如下： | OH_NativeXComponent_GetXComponentOffset(OH_NativeXComponent *component, const void *window, double *x, double *y) | 获取ArkUI XComponent组件相对屏幕左上顶点的偏移量 | | OH_NativeXComponent_GetTouchEvent(OH_NativeXComponent *component, const void *window, OH_NativeXComponent_TouchEvent *touchEvent) | 获取ArkUI XComponent调度的触摸事件 | | OH_NativeXComponent_GetTouchPointToolType(OH_NativeXComponent *component, uint32_t pointIndex, OH_NativeXComponent_TouchPointToolType *toolType) | 获取ArkUI XComponent触摸点工具类型 | -| OH_NativeXComponent_GetTouchPointTiltX(OH_NativeXComponent *component, uint32_t pointIndex, float *tiltX) | 获取ArkUI XComponent触摸点倾斜与X轴角度 | +| OH_NativeXComponent_GetTouchPointTiltX(OH_NativeXComponent *component, uint32_t pointIndex, float *tiltX) | 获取ArkUI XComponent触摸点倾斜与X轴角度 | | OH_NativeXComponent_GetTouchPointTiltY(OH_NativeXComponent *component, uint32_t pointIndex, float *tiltY) | 获取ArkUI XComponent触摸点倾斜与Y轴角度 | | OH_NativeXComponent_GetMouseEvent(OH_NativeXComponent *component, const void *window, OH_NativeXComponent_MouseEvent *mouseEvent) | 获取ArkUI XComponent调度的鼠标事件 | | OH_NativeXComponent_RegisterCallback(OH_NativeXComponent *component, OH_NativeXComponent_Callback *callback) | 实例注册回调 | @@ -81,10 +80,7 @@ Native XComponent相关函数如下： ### 约束与限制 -1.本示例仅支持标准系统上运行，支持设备：华为手机。 - -2.HarmonyOS系统：HarmonyOS NEXT Developer Beta1及以上。 - -3.DevEco Studio版本：DevEco Studio NEXT Developer Beta1及以上。 - -4.HarmonyOS SDK版本：HarmonyOS NEXT Developer Beta1 SDK及以上。 +1. 本示例仅支持标准系统上运行，支持设备：华为手机。 +2. HarmonyOS系统：HarmonyOS 5.0.0 Release及以上。 +3. DevEco Studio版本：DevEco Studio 5.0.0 Release及以上。 +4. HarmonyOS SDK版本：HarmonyOS 5.0.0 Release SDK及以上。