1# Native Window 2 3### 介绍 4 5本示例中主要介绍开发者在利用[Native XComponent](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkui/native__interface__xcomponent_8h.md)来获取[NativeWindow](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkgraphics2d/_native_window.md)实例,通过数据填充改变矩形框颜色。并提供从[NativeImage](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkgraphics2d/_o_h___native_image.md)中获取NativeWindow进行buffer轮转的案例,通过NativeWindow生产buffer来触发NativeImage的可用帧回调。 6 7### 效果预览 8 9| 主页 | 改变矩形框颜色 | 生产buffer | 获取可用帧回调次数 | 10| ------------------------------------ | ------------------------------------------------ | --------------------------------------------------------- | --------------------------------------------------------- | 11|  |  |  || 12 13使用说明 14 151. 安装编译生成的hap包,并打开应用; 162. 点击页面底部“Chaneg Color”按钮,矩形框填充区域将改变颜色,黄蓝切换; 173. 点击页面底部“produce buffer”按钮,NativeWindow将生产数据并发送给NativeImage,页面展示了生产buffer的次数; 184. 点击页面底部“update available buffer count”按钮,将展示NativeImage收到的可用帧回调次数。 19 20### 工程目录 21 22``` 23├──entry/src/main 24│ ├──cpp // C++代码区 25│ │ ├──CMakeLists.txt // CMake配置文件 26│ │ ├──logger_common.h // 日志封装定义文件 27│ │ ├──NativeImageAdaptor.cpp // NativeImage功能适配模块 28│ │ ├──NativeRender.cpp // NativeWindow和XComponentContext联合显示模块 29│ ├──ets // ets代码区 30│ │ ├──entryability 31│ │ │ ├──EntryAbility.ts // 程序入口类 32| | ├──interface 33│ │ │ └──NativeWindowContext.ts // NativeWindowContext 34│ │ └──pages // 页面文件 35│ │ └──Index.ets // 主界面 36| ├──resources // 资源文件目录 37``` 38 39### 具体实现 40 41通过在IDE中创建Native c++ 工程,在c++代码中定义对外接口为DrawColor,在js侧调用该接口可改变窗口颜色;从NativeImage中创建NativeWindow,在c++代码中定义对外接口为ProduceBuffer,js调用该接口后, NativeWindow会生产buffer并将该buffer flush给NativeImage,之后NativeImage将收到可用帧的回调,js侧调用GetAvailableCount接口,可以获取回调触发次数,并展示在界面上,正常情况下FlushBuffer的次数和可用帧回调触发次数一致。 42 43源码参考:[cpp目录](entry/src/main/cpp)下的文件。 44 45涉及到的相关接口: 46 47 48| 接口名 | 描述 | 49| -------- | -------- | 50| OH_NativeWindow_CreateNativeWindow (void *pSurface) | 创建OHNativeWindow实例,每次调用都会产生一个新的OHNativeWindow实例 | 51| OH_NativeWindow_DestroyNativeWindow (OHNativeWindow *window) | 将OHNativeWindow对象的引用计数减1,当引用计数为0的时候,该OHNativeWindow对象会被析构掉 | 52| OH_NativeWindow_CreateNativeWindowBufferFromNativeBuffer (OH_NativeBuffer *nativeBuffer) | 创建OHNativeWindowBuffer实例,每次调用都会产生一个新的OHNativeWindowBuffer实例 | 53| OH_NativeWindow_DestroyNativeWindowBuffer (OHNativeWindowBuffer *buffer) | 将OHNativeWindowBuffer对象的引用计数减1,当引用计数为0的时候,该OHNativeWindowBuffer对象会被析构掉 | 54| OH_NativeWindow_NativeWindowRequestBuffer (OHNativeWindow *window, OHNativeWindowBuffer **buffer, int *fenceFd) | 通过OHNativeWindow对象申请一块OHNativeWindowBuffer,用以内容生产 | 55| OH_NativeWindow_NativeWindowFlushBuffer (OHNativeWindow *window, OHNativeWindowBuffer *buffer, int fenceFd, Region region) | 通过OHNativeWindow将生产好内容的OHNativeWindowBuffer放回到Buffer队列中,用以内容消费 | 56| OH_NativeWindow_GetLastFlushedBuffer (OHNativeWindow *window, OHNativeWindowBuffer **buffer) | 从OHNativeWindow获取上次送回到buffer队列中的OHNativeWindowBuffer | 57| OH_NativeWindow_NativeWindowHandleOpt (OHNativeWindow *window, int code,...) | 设置/获取OHNativeWindow的属性,包括设置/获取宽高、内容格式等 | 58| OH_NativeWindow_GetBufferHandleFromNative (OHNativeWindowBuffer *buffer) | 通过OHNativeWindowBuffer获取该buffer的BufferHandle指针 | 59| OH_NativeBuffer_SetColorSpace (OH_NativeBuffer *buffer, OH_NativeBuffer_ColorSpace colorSpace) | 为OH_NativeBuffer设置颜色空间属性 | 60| OH_NativeImage_SetOnFrameAvailableListener (OH_NativeImage *image, OH_OnFrameAvailableListener listener) | 设置帧可用回调 | 61| OH_NativeImage_UnsetOnFrameAvailableListener (OH_NativeImage *image) | 取消设置帧可用回调 | 62| OH_NativeImage_AcquireNativeWindow (OH_NativeImage *image) | 获取与OH_NativeImage相关联的OHNativeWindow指针。 该OHNativeWindow后续不再需要时需要调用OH_NativeWindow_DestroyNativeWindow释放 | 63 64详细的接口说明请参考[NativeWindow](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkgraphics2d/_native_window.md),[NativeImage](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkgraphics2d/_o_h___native_image.md),[NativeBuffer](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkgraphics2d/_o_h___native_buffer.md)。 65 66### 相关权限 67 68不涉及。 69 70### 依赖 71 72XComponent NativeWindow NativeImage EGL。 73 74### 约束与限制 75 761. 本示例仅支持标准系统上运行; 772. 本示例为Stage模型,已适配API version 11版本SDK,SDK版本号4.1.3.3及以上版本,镜像版本号支持4.1.3.3及以上版本; 783. 本示例需要使用DevEco Studio 4.0 Beta2 版本号(4.0.0.400)及以上版本才可编译运行。 79### 下载 80 81如需单独下载本工程,执行如下命令: 82 83``` 84git init 85git config core.sparsecheckout true 86echo code/BasicFeature/Native/NdkNativeWindow/ > .git/info/sparse-checkout 87git remote add origin https://gitee.com/openharmony/applications_app_samples.git 88git pull origin master 89``` 90