# XEngine-samplecode-Vulkan-TemporalUpscaleDemo-cpp

**Repository Path**: harmonyos_samples/xengine-samplecode-vulkan-temporal-upscale-demo-cpp

## Basic Information

- **Project Name**: XEngine-samplecode-Vulkan-TemporalUpscaleDemo-cpp
- **Description**: 本示例基于XEngine加速引擎接口，实现图像超分的功能。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 3
- **Created**: 2025-01-03
- **Last Updated**: 2025-12-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Upscaling and Adaptative VRS (Vulkan) Capabilities of XEngine Kit

## Overview

In this codelab, you'll learn how to use the GPU spatial upscaling API and AI temporal upscaling API of XEngine Kit to perform texture upscaling and enable adaptive VRS. The sample code takes drawing the scenes of Sponza Palace as an example, and builds up the Vulkan environment using XComponent. The demo project is created based on the Native C++ template.

## Preview

You can tap the drop-down list box to switch between upscaling modes and tap the check box to enable or disable adaptative VRS. The following figure shows the Sponza Palace scene drawn using XComponent.

![XEngine Temporal Upscale](screenshots/device/XEngine_VULKAN_Temporal_Upscale_Example.png)

## Related Concepts
- [XComponent](https://developer.huawei.com/consumer/en/doc/harmonyos-references/ts-basic-components-xcomponent): The XComponent can accept and display media data input.

## Instructions

1. Run the sample code.
2. Tap the drop-down list box and switch between **no upscale** (no upscaling), **spatial upscale** (GPU spatial upscaling), **fsr upscale** (FSR1.0 upscaling) modes，and **temporal upscale**(AI temporal upscaling) modes.
3. Tap the check box to enable or disable adaptive VRS.

## Project Directory
```
├──entry/src/main	         	        // Code area
│  ├──cpp
│  │  ├──types
│  │  │  └──libnativerender
│  │  │    	└──index.d.ts      			// API registration file at the native layer
│  │  ├──napi_init.cpp                  // Functions of APIs at the native layer
│  │  ├──CMakeLists.txt                 // Compilation configurations at the native layer
│  │  ├──3rdParty                       // Third-party component
│  │  ├──common                         // Common APIs
│  │  ├──file                           // File management
│  │  ├──libs                           // Third-party dynamic libraries
│  │  ├──manager                        // Binding ArkTs to Native Interfaces
│  │  ├──render                         // Rendering
│  │  └──vulkanbase                     // Encapsulated basic Vulkan capabilities
│  ├──ets
│  │  ├──common
│  │  │  └──CommonConstants.ets         // Common constants
│  │  ├──entryability
│  │  │  └──EntryAbility.ts             // Entry class
│  │  ├──pages
│  │  │  └──index.ets                   // Home screen display class
│  └──resources                         // Directory of resource files
│     ├──base
│     │  └──media
│     │     └──icon.png                 // Image resources
│     └──rawfile
│     	 └──shader                      // Stores shaders
│        └──Sponza
│ 	        └──textures		        	// Stores image resources
│ 	        └──copyright.txt            // Copyright information and usage license
│ 	        └──sponza.mtl               // Describes material properties used in the model
│           └──sponza.obj     	        // Model resources
```

## Implementation Details
The sample code uses the following APIs defined in XEngine Kit:
* VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_EnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice, uint32_t* pPropertyCount, XEG_ExtensionProperties* pProperties);
* VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CreateSpatialUpscale(VkDevice device, const XEG_SpatialUpscaleCreateInfo*  pXegSpatialUpscaleCreateInfo, XEG_SpatialUpscale* pXegSpatialUpscale);
* VKAPI_ATTR void VKAPI_CALL HMS_XEG_CmdRenderSpatialUpscale(VkCommandBuffer commandBuffer, XEG_SpatialUpscale xegSpatialUpscale, XEG_SpatialUpscaleDescription* pXegSpatialUpscaleDescription);
* VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroySpatialUpscale(XEG_SpatialUpscale xegSpatialUpscale);
* VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CreateAdaptiveVRS(VkDevice device, XEG_AdaptiveVRSCreateInfo* pXegAdaptiveVRSCreateInfo, XEG_AdaptiveVRS* pXegAdaptiveVRS);
* VKAPI_ATTR void VKAPI_CALL HMS_XEG_CmdDispatchAdaptiveVRS(VkCommandBuffer cmdBuffer, XEG_AdaptiveVRS xegAdaptiveVRS, XEG_AdaptiveVRSDescription* pXegAdaptiveVRSDescription);
* VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroyAdaptiveVRS(XEG_AdaptiveVRS xegAdaptiveVRS);
* VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CreateTemporalUpscale(VkDevice device, XEG_TemporalUpscaleCreateInfo* pTemporalUpscaleInfo, XEG_TemporalUpscale* pTemporalUpscale);
* VKAPI_ATTR void VKAPI_CALL HMS_XEG_CmdRenderTemporalUpscale(VkCommandBuffer commandBuffer, XEG_TemporalUpscale temporalUpscale, XEG_TemporalUpscaleDescription* pDescription);
* VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroyTemporalUpscale(XEG_TemporalUpscale temporalUpscale);
You can call the APIs listed above to implement upscaling and adaptative VRS.

## Required Permissions

N/A

## Dependency

* This sample code depends on the Assimp third-party component, In this example, the third-party component has been configured and compiled. If you need to replace the third-party component, compile it based on the system version. For details, visit https://gitee.com/openharmony-sig/tpc_c_cplusplus/tree/master.
* 3D model resources: "[Crytek Sponza](https://casual-effects.com/data/)" by Frank Meinl; Crytek is licensed under [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/)/replace "\\\" with "/" in the **sponza.mtl** file.

## Constraints

1. The sample code can only run on devices with a standard system. Supported devices: For details, see [Hardware Requirements](https://developer.huawei.com/consumer/en/doc/harmonyos-guides/xengine-kit-preparations) in the XEngine Development Guide.
2. This sample demonstrates the stage model, which supports API version 12 or later.
3. HarmonyOS: HarmonyOS 5.0.0 Release or later.
4. DevEco Studio: DevEco Studio 5.0.0 Release or later.
5. HarmonyOS SDK: HHarmonyOS 5.0.0 Release SDK or later.