自适应VRS
======

XEngine Kit提供自适应VRS功能，其通过合理分配画面的计算资源，视觉无损降低渲染频次，使不同的渲染图像使用不同的渲染速率，能够有效提高渲染性能。

#### 约束与限制

*   支持的设备类型：Phone，从5.0.2(14)版本开始，新增支持Tablet、PC/2in1设备，从5.1.1(19)版本开始新增支持TV设备。
    
*   可通过以下方式查询相关扩展特性是否支持：
    
    对于OpenGL ES，使用[HMS\_XEG\_GetString](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/xengine-kit-xengine#hms_xeg_getstring)扩展特性查询接口进行查询，如查询结果包含[XEG\_ADAPTIVE\_VRS\_EXTENSION\_NAME](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/xengine-kit-xengine#xeg_adaptive_vrs_extension_name)，则表示支持该特性，若查询结果未包含，则表示不支持该特性。
    

#### 接口说明

以下接口为自适应VRS设置接口，如需使用更丰富的设置和查询接口，具体API说明详见[接口文档](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/xengine-kit-xengine)。

| 接口名 | 描述 |
| :-- | :-- |
| const GLubyte \* HMS\_XEG\_GetString (GLenum name) | XEngine OpenGL ES扩展特性查询接口。 |
| GL\_APICALL void GL\_APIENTRY HMS\_XEG\_AdaptiveVRSParameter (GLenum pname, GLvoid \* param) | 设置自适应VRS的参数。 |
| GL\_APICALL void GL\_APIENTRY HMS\_XEG\_DispatchAdaptiveVRS (GLfloat \* reprojectionMatrix, GLuint inputColorImage, GLuint inputDepthImage, GLuint shadingRateImage) | 计算着色率图像。 |
| GL\_APICALL void GL\_APIENTRY HMS\_XEG\_ApplyAdaptiveVRS (GLuint shadingRateImage) | 将着色率图像应用到渲染目标中。 |
| VKAPI\_ATTR VkResult VKAPI\_CALL HMS\_XEG\_EnumerateDeviceExtensionProperties (VkPhysicalDevice physicalDevice, uint32\_t \* pPropertyCount, XEG\_ExtensionProperties \* pProperties) | XEngine Vulkan扩展特性查询接口。 |
| VKAPI\_ATTR VkResult VKAPI\_CALL HMS\_XEG\_CreateAdaptiveVRS (VkDevice device, XEG\_AdaptiveVRSCreateInfo \* pXegAdaptiveVRSCreateInfo, XEG\_AdaptiveVRS \* pXegAdaptiveVRS) | 创建XEG\_AdaptiveVRS对象。 |
| VKAPI\_ATTR void VKAPI\_CALL HMS\_XEG\_CmdDispatchAdaptiveVRS (VkCommandBuffer commandBuffer, XEG\_AdaptiveVRS xegAdaptiveVRS, XEG\_AdaptiveVRSDescription \* pXegAdaptiveVRSDescription) | 执行计算自适应VRS命令。 |
| VKAPI\_ATTR void VKAPI\_CALL HMS\_XEG\_DestroyAdaptiveVRS (XEG\_AdaptiveVRS xegAdaptiveVRS) | 销毁XEG\_AdaptiveVRS对象。 |

#### 业务流程

*   下面是基于GLES图形API平台集成自适应VRS的主要业务流程
    
    ![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/d/v3/kP4U6sDdTBereyacl78HsQ/zh-cn_image_0000002594669024.jpg?HW-CC-KV=V1&HW-CC-Date=20260612T073545Z&HW-CC-Expire=86400&HW-CC-Sign=3B4790756D504995DB3D818E8B041574331485BEECA1DE700BFC9F03815BFCA4)
    

1.  用户在进入游戏初始化场景时调用HMS\_XEG\_GetString接口查询XEngine支持的特性，当查询接口返回支持的特性列表中包含自适应VRS时代表可以使用此特性。
2.  此时调用HMS\_XEG\_AdaptiveVRSParameter接口配置自适应VRS参数。
3.  当游戏运行时，游戏渲染当前帧纹理。
4.  在使用自适应VRS特性的阶段前，调用HMS\_XEG\_DispatchAdaptiveVRS接口计算着色率图。
5.  调用HMS\_XEG\_ApplyAdaptiveVRS将着色率图像应用到渲染目标中。
6.  游戏渲染剩下的纹理，如UI等。
7.  当前帧已全部渲染完成，进行送显。
8.  当游戏退出时，自适应VRS资源会自行释放。

*   下面是基于Vulkan图形API平台集成自适应VRS的主要业务流程
    
    ![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/e5/v3/nHPRIRCvS2GBNRDwHBn_fw/zh-cn_image_0000002594828952.jpg?HW-CC-KV=V1&HW-CC-Date=20260612T073545Z&HW-CC-Expire=86400&HW-CC-Sign=C0724E803DE844FAB4960D037C50167846393A2DCC66B7AD785D7C26CF77CFE9)
    

1.  用户在进入游戏初始化场景时调用HMS\_XEG\_EnumerateDeviceExtensionProperties接口查询XEngine支持的特性，当查询接口返回支持的特性列表中包含自适应VRS时代表可以使用此特性。
2.  此时调用HMS\_XEG\_CreateAdaptiveVRS接口创建自适应VRS实例。
3.  使用自适应VRS特性时，需要创建能够支持VRS的vulkan资源。
4.  当游戏运行时，游戏渲染当前帧纹理。
5.  调用HMS\_XEG\_CmdDispatchAdaptiveVRS计算着色率图。
6.  将着色率图像应用到渲染目标中。
7.  渲染剩下的游戏纹理，如UI等。
8.  当前帧已全部渲染完成，进行送显。
9.  当游戏退出时，调用HMS\_XEG\_DestroyAdaptiveVRS接口销毁自适应VRS实例。

#### 开发步骤

本章以OpenGL ES和Vulkan图像API集成为例，说明XEngine集成操作过程。

#### \[h2\]配置项目

编译HAP时，Native层so编译需要依赖NDK中的libxengine.so。

*   头文件引用
    
    按需引用XEngine的头文件，如使用OpenGL ES自适应VRS功能。
    
    #include "xengine/xeg\_gles\_extension.h"
    #include "xengine/xeg\_gles\_adaptive\_vrs.h"
    
    按需引用XEngine的头文件，如使用Vulkan自适应VRS功能。
    
    #include "xengine/xeg\_vulkan\_adaptive\_vrs.h"
    // ...
    #include "xengine/xeg\_vulkan\_extension.h"
    
*   编写CMakeLists.txt
    
    按需引用XEngine的CMakeLists，如使用OpenGL ES自适应VRS功能，CMakeLists.txt部分示例代码如下，完整示例代码请参见[Demo（GPU加速引擎-GLES）](https://gitcode.com/harmonyos_samples/xengine-samplecode-gles-demo-cpp)。
    
    find\_library(
        # Sets the name of the path variable.
        EGL-lib
        # Specifies the name of the NDK library that
        # you want CMake to locate.
        EGL
    )
    
    find\_library(
        # Sets the name of the path variable.
        GLES-lib
        # Specifies the name of the NDK library that
        # you want CMake to locate.
        GLESv3
    )
    
    find\_library(
       # Sets the name of the path variable.
       xengine-lib
       # Specifies the name of the NDK library that
       # you want CMake to locate.
       xengine
    )
    # ...
    target\_link\_libraries(nativerender PUBLIC
        ${EGL-lib} ${GLES-lib} ${xengine-lib}
        # ...
        )
    
    按需引用XEngine的CMakeLists，如使用Vulkan自适应VRS功能，CMakeLists.txt部分示例代码如下，完整示例代码请参见[Demo（GPU加速引擎-Vulkan）](https://gitcode.com/harmonyos_samples/xengine-samplecode-vulkan-demo-cpp)。
    
    find\_library(
        # Sets the name of the path variable.
        xengine-lib
        # Specifies the name of the NDK library that
        # you want CMake to locate.
        xengine
    )
    
    target\_link\_libraries(nativerender PUBLIC
        # ...
        ${xengine-lib})
    

#### \[h2\]集成自适应VRS功能（OpenGL ES）

自适应VRS功能OpenGL ES版本的着色率纹理创建和绑定由特性提供的接口实现。

在调用XEngine Kit能力前，需要先通过[Syscap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/syscap#什么是systemcapabilitysyscap)查询您的目标设备是否支持SystemCapability.Graphic.XEngine系统能力。

1.  调用[HMS\_XEG\_GetString](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/xengine-kit-xengine#hms_xeg_getstring)接口，获取XEngine支持的扩展信息，只有在支持[XEG\_ADAPTIVE\_VRS\_EXTENSION\_NAME](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/xengine-kit-xengine#xeg_adaptive_vrs_extension_name)扩展时才可以使用自适应VRS的相关接口。
    
    // 查询XEngine支持的GLES扩展信息
    std::string extensions = (const char\*)HMS\_XEG\_GetString(XEG\_EXTENSIONS);
    LOGI("Model3DSponza support extensions: %{public}s", extensions.c\_str());
    // ...
    // 查询是否支持自适应VRS
    std::string::size\_type adaptiveVRSIdx = extensions.find(XEG\_ADAPTIVE\_VRS\_EXTENSION\_NAME);
    if (adaptiveVRSIdx == std::string::npos) {
        isSupportVrs = false;
        LOGE("Model3DSponza not support VRS.");
    }
    
2.  调用[HMS\_XEG\_AdaptiveVRSParameter](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/xengine-kit-xengine#hms_xeg_adaptivevrsparameter)接口，对自适应VRS的参数赋值。
    
    // inputWidth与inputHeight分别为用户自定义的渲染宽度与渲染高度
    // inputSize为上一帧渲染管线最终渲染的图像尺寸，用户可自定义
    GLsizei inputSize\[2\] = {inputWidth, inputHeight};
    HMS\_XEG\_AdaptiveVRSParameter(XEG\_ADAPTIVE\_VRS\_INPUT\_SIZE, inputSize);
    // inputRegion为上一帧渲染管线最终渲染的图像区域，用户可自定义
    GLuint inputRegion\[4\] = {0, 0, static\_cast<GLuint>(inputWidth), static\_cast<GLuint>(inputHeight)};
    HMS\_XEG\_AdaptiveVRSParameter(XEG\_ADAPTIVE\_VRS\_INPUT\_REGION, inputRegion);
    // flip为判断是否执行图像上下翻转，为true表示进行图像上下翻转，false则表示不进行图像上下翻转，此处以false为例
    GLboolean flip = false;
    HMS\_XEG\_AdaptiveVRSParameter(XEG\_ADAPTIVE\_VRS\_FLIP, &flip);
    // texelSizes为渲染的分片大小，用户可自定义，当前支持\[8, 8\]和\[16, 16\]两种规格
    GLsizei texelSize\[2\] = {ADAPTIVE\_VRS\_TEXEL\_SIZE, ADAPTIVE\_VRS\_TEXEL\_SIZE};
    HMS\_XEG\_AdaptiveVRSParameter(XEG\_ADAPTIVE\_VRS\_TEXEL\_SIZE, texelSize);
    // sensitivity为控制生成着色率图像的阈值，用户可自定义，建议取值范围为\[0.0, 1.0\]
    GLfloat sensitivity = 0.3;
    HMS\_XEG\_AdaptiveVRSParameter(XEG\_ADAPTIVE\_VRS\_ERROR\_SENSITIVITY, &sensitivity);
    
3.  调用[HMS\_XEG\_DispatchAdaptiveVRS](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/xengine-kit-xengine#hms_xeg_dispatchadaptivevrs)接口计算着色率图像。
    
    // reprojectionMatrix为用户根据投影矩阵和观察矩阵计算得来的重投影矩阵
    // light为用户自定义上一帧渲染管线最终渲染结果颜色附件纹理
    // depth为用户自定义当前帧渲染管线最终渲染结果深度附件纹理
    // sri为用户可自定义生成着色率图像信息的纹理
    HMS\_XEG\_DispatchAdaptiveVRS(reprojectionM, light, depth, sri);
    
4.  调用[HMS\_XEG\_ApplyAdaptiveVRS](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/xengine-kit-xengine#hms_xeg_applyadaptivevrs)接口，将着色率图像应用到渲染目标中。
    
    HMS\_XEG\_ApplyAdaptiveVRS(sri);
    

#### \[h2\]集成自适应VRS功能（Vulkan）

在调用XEngine Kit能力前，需要先通过[Syscap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/syscap#什么是systemcapabilitysyscap)查询您的目标设备是否支持SystemCapability.Graphic.XEngine系统能力。

1.  调用[HMS\_XEG\_EnumerateDeviceExtensionProperties](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/xengine-kit-xengine#hms_xeg_enumeratedeviceextensionproperties)接口，获取XEngine支持的扩展信息，只有在支持[XEG\_ADAPTIVE\_VRS\_EXTENSION\_NAME](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/xengine-kit-xengine#xeg_adaptive_vrs_extension_name)扩展时才可以使用自适应VRS的相关接口。
    
    // 查询XEngine支持的Vulkan扩展列表
    std::vector<std::string> supportedExtensions;
    uint32\_t pPropertyCount;
    // physicalDevice为Vulkan物理设备，用户需进行初始化
    HMS\_XEG\_EnumerateDeviceExtensionProperties(physicalDevice, &pPropertyCount, nullptr);
    if (pPropertyCount > 0) {
        std::vector<XEG\_ExtensionProperties> pProperties(pPropertyCount);
        if (HMS\_XEG\_EnumerateDeviceExtensionProperties(physicalDevice, &pPropertyCount,
            &pProperties.front()) == VK\_SUCCESS) {
            for (auto ext : pProperties) {
                supportedExtensions.push\_back(ext.extensionName);
            }
        }
    }
    // ...
    // 查询是否支持自适应VRS
    if (std::find(supportedExtensions.begin(), supportedExtensions.end(), XEG\_ADAPTIVE\_VRS\_EXTENSION\_NAME) ==
        supportedExtensions.end()) {
        LOGE("XEG\_adaptive\_vrs not support");
        isSupportVRS = false;
    }
    
2.  声明实例句柄。
    
    XEG\_AdaptiveVRS xeg\_adaptiveVRS = nullptr;
    
3.  调用[HMS\_XEG\_CreateAdaptiveVRS](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/xengine-kit-xengine#hms_xeg_createadaptivevrs)接口，定义并创建实例。
    
    // VkExtent2D inputSize为上一帧渲染管线最终渲染的图像尺寸，用户可自定义
    VkExtent2D inputSize;
    VkRect2D inputRegion{};
    
    inputSize.width = highResWidth;
    // VkRect2D为Vulkan指定的二维区域结构
    // inputRegion为自适应VRS输入纹理区域，用户可自定义
    inputSize.height = highResHeight;
    // inputRegion.extent.width与inputRegion.extent.height分别为纹理采样宽高
    inputRegion.extent.width = highResWidth;
    inputRegion.extent.height = highResHeight;
    // inputRegion.offset.x和inputRegion.offset.y为原点偏移量
    inputRegion.offset.x = 0;
    inputRegion.offset.y = 0;
    // xeg\_createInfo.inputSize为上一帧渲染管线最终渲染的图像尺寸
    xeg\_createInfo.inputSize = inputSize;
    // xeg\_createInfo.inputRegion为上一帧渲染管线最终渲染的图像区域
    xeg\_createInfo.inputRegion = inputRegion;
    // xeg\_createInfo.adaptiveTileSize为自适应VRS的渲染的分片大小
    // VRS\_TILE\_SIZE为自适应VRS的渲染的分片大小
    xeg\_createInfo.adaptiveTileSize = VRS\_TILE\_SIZE;
    // xeg\_createInfo.errorSensitivity为控制最终生成着色率纹理结果的阈值
    xeg\_createInfo.errorSensitivity = SENSITIVITY;
    // xeg\_createInfo.flip为判断是否执行图像上下翻转，为true表示进行图像上下翻转，false则表示不进行图像上下翻转，此处以false为例
    xeg\_createInfo.flip = false;
    // device逻辑设备，用户需进行初始化
    // XEG\_AdaptiveVRSCreateInfo为自适应VRS实例句柄对象的参数信息
    // XEG\_AdaptiveVRSDescription为下发绘制着色率纹理命令所需参数信息
    VkResult res = HMS\_XEG\_CreateAdaptiveVRS(device, &xeg\_createInfo, &xeg\_adaptiveVRS);
    
4.  调用[HMS\_XEG\_CmdDispatchAdaptiveVRS](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/xengine-kit-xengine#hms_xeg_cmddispatchadaptivevrs)接口，下发自适应VRS命令，生成perImage着色率纹理。
    
    XEG\_AdaptiveVRSDescription xeg\_description;
    // inputColorImageView为用户自定义的上一帧渲染管线最终渲染结果颜色附件纹理
    xeg\_description.inputColorImage = upscale ? upscaleFrameBuffers.light.color.view : frameBuffers.light.color.view;
    // inputDepthImageView为用户自定义的当前帧渲染管线最终渲染结果深度附件纹理
    xeg\_description.inputDepthImage =
        upscale ? upscaleFrameBuffers.gBufferLight.depth.view : frameBuffers.gBufferLight.depth.view;
    // outputShadingRateImage为用户自定义的生成着色率图信息的纹理
    xeg\_description.outputShadingRateImage =
        upscale ? upscaleFrameBuffers.shadingRate.color.view : frameBuffers.shadingRate.color.view;
    // xeg\_description.reprojectionMatrix为使用投影矩阵和观察矩阵计算而来的重投影矩阵
    xeg\_description.reprojectionMatrix = nullptr;
    // ...
        HMS\_XEG\_CmdDispatchAdaptiveVRS(commandBuffer, xeg\_adaptiveVRS, &xeg\_description);
    
5.  调用[HMS\_XEG\_DestroyAdaptiveVRS](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/xengine-kit-xengine#hms_xeg_destroyadaptivevrs)接口，卸载VRS实例，清理VRS相关资源。
    
    HMS\_XEG\_DestroyAdaptiveVRS(xeg\_adaptiveVRS);