1# Vulkan开发指导
2
3## 场景介绍
4
5Vulkan是一套用来做2D和3D渲染的图形应用程序接口，其中创建VkSurfaceKHR对象是一个非常关键的步骤，在OpenHarmony中，VkSurfaceKHR会对接到OHNativeWindow模块功能，实现Buffer轮转。
6
7在OpenHarmony中，需要通过OHNativeWindow来创建VkSurfaceKHR对象，而OHNativeWindow需要从XComponent中获取，所以此场景下需要配合XComponent模块和NativeWindow模块一起使用。
8
9## 接口说明
10
11| 接口名                                                       | 描述                   |
12| ------------------------------------------------------------ | ---------------------- |
13| vkCreateSurfaceOHOS (VkInstance instance, const VkSurfaceCreateInfoOHOS\* pCreateInfo, const VkAllocationCallbacks\* pAllocator, VkSurfaceKHR\* pSurface) | 创建VkSurfaceKHR对象。 |
14
15更多的接口说明请参考[Vulkan](vulkan.md)。
16
17## 开发步骤
18
19以下步骤说明了如何创建一个VkSurfaceKHR对象。
20
21首先，使用平台扩展的接口，需要定义一个宏`VK_USE_PLATFORM_OHOS`，我们在CMakeLists.txt定义这个宏。
22
23```txt
24ADD_DEFINITIONS(-DVK_USE_PLATFORM_OHOS=1)
25```
26
27**添加动态链接库**
28
29CMakeLists.txt中添加以下lib。
30
31```txt
32libace_ndk.z.so
33libnative_window.so
34libvulkan.so
35```
36
37> **说明:**
38>
39> 在程序中通过dlopen函数链接libvulkan.so动态库时不需要在CMake中增加依赖，否则会导致符号冲突。
40
41**头文件**
42
43```c++
44#include <ace/xcomponent/native_interface_xcomponent.h>
45#include <native_window/external_window.h>
46#include <vulkan/vulkan.h>
47```
48
491. **首先需要创建一个Vulkan实例**。
50
51   ```c++
52   VkInstance instance = VK_NULL_HANDLE;
53
54   VkApplicationInfo appInfo = {};
55   appInfo.sType = VK_STRUCTURE_TYPE_APPLICATION_INFO;
56   appInfo.pApplicationName = "vulkanExample";
57   appInfo.pEngineName = "vulkanExample";
58   appInfo.apiVersion = VK_API_VERSION_1_3;
59
60   VkInstanceCreateInfo instanceCreateInfo = {};
61   instanceCreateInfo.sType = VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO;
62   instanceCreateInfo.pNext = NULL;
63   instanceCreateInfo.pApplicationInfo = &appInfo;
64
65   std::vector<const char *> instanceExtensions = {
66       VK_KHR_SURFACE_EXTENSION_NAME,
67       VK_OHOS_SURFACE_EXTENSION_NAME // Surface扩展
68   };
69   instanceCreateInfo.enabledExtensionCount = static_cast<uint32_t>(instanceExtensions.size());
70   instanceCreateInfo.ppEnabledExtensionNames = instanceExtensions.data();
71
72   vkCreateInstance(&instanceCreateInfo, nullptr, &instance);
73   ```
74
752. **获取OHNativeWindow**。
76
77   OHNativeWindow需要从XComponent组件中获取，下面提供一份从XComponent组件中获取OHNativeWindow的代码示例，XComponent模块的具体使用方法请参考[XComponent模块的介绍文档](../../ui/napi-xcomponent-guidelines.md)。
78
79   1. ets/pages/Index.ets中增加一个XComponent组件。
80
81      ```ts
82      XComponent({
83          id: 'xcomponentId',
84          type: 'surface',
85          libraryname: 'entry'
86      })
87      .margin({ bottom: 20 })
88      .width(360)
89      .height(360)
90      ```
91
92   2. 从XComponent组件中获取OHNativeWindow。
93
94      ```c++
95      // XComponent在创建Suface时的回调函数
96      void OnSurfaceCreatedCB(OH_NativeXComponent *component, void *window) {
97          // 在回调函数里可以拿到OHNativeWindow
98          OHNativeWindow *nativeWindow = static_cast<OHNativeWindow *>(window);
99      }
100
101      static napi_value Init(napi_env env, napi_value exports) {
102          napi_property_descriptor desc[] = {{"add", nullptr, Add, nullptr, nullptr, nullptr, napi_default, nullptr}};
103          napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
104
105          napi_value exportInstance = nullptr;
106          OH_NativeXComponent *nativeXComponent = nullptr;
107          // 获取nativeXComponent
108          napi_get_named_property(env, exports, OH_NATIVE_XCOMPONENT_OBJ, &exportInstance);
109          napi_unwrap(env, exportInstance, reinterpret_cast<void **>(&nativeXComponent));
110          // 获取XComponentId
111          char idStr[OH_XCOMPONENT_ID_LEN_MAX + 1] = {};
112          uint64_t idSize = OH_XCOMPONENT_ID_LEN_MAX + 1;
113          OH_NativeXComponent_GetXComponentId(nativeXComponent, idStr, &idSize);
114
115          // 声明一个XComponent的Callback
116          OH_NativeXComponent_Callback callback;
117          // 注册OnSurfaceCreated回调函数
118          callback.OnSurfaceCreated = OnSurfaceCreatedCB;
119          // 将callback注册给nativeXComponent
120          OH_NativeXComponent_RegisterCallback(nativeXComponent, &callback);
121
122          return exports;
123      }
124      ```
125
1263. **创建VkSurfaceKHR对象**。
127
128   ```c++
129   VkSurfaceKHR surface = VK_NULL_HANDLE;
130   VkSurfaceCreateInfoOHOS surfaceCreateInfo = {};
131   surfaceCreateInfo.sType = VK_STRUCTURE_TYPE_SURFACE_CREATE_INFO_OHOS;
132   surfaceCreateInfo.window = nativeWindow; // 这里的nativeWindow就是从上一步骤OnSurfaceCreatedCB回调函数中拿到的
133   int err = vkCreateSurfaceOHOS(instance, &surfaceCreateInfo, NULL, &surface);
134   if (err != VK_SUCCESS) {
135       // Create Surface Failed.
136   }
137   ```
138
139## 相关实例
140
141针对Vulkan的使用，具体可见以下相关实例：
142
143- [XComponent组件对接Vulkan（API11）](https://gitee.com/openharmony/applications_app_samples/tree/master/code/BasicFeature/Native/NdkVulkan)
144
145后续更多vulkan的用法请参考[Vulkan官方网站](https://www.vulkan.org/)。