目录

XEngine

概述

提供XEngine图形相关能力接口。

系统能力: SystemCapability.Graphic.XEngine

起始版本: 5.0.0(12)

汇总

[h2]文件

名称

描述

xeg_extension_defs.h

提供XEngine扩展特性宏定义信息。

xeg_gles_adaptive_vrs.h

XEngine VRS特性接口。使用此头文件的接口前需要通过HMS_XEG_GetString接口查询XEG_ADAPTIVE_VRS_EXTENSION_NAME扩展可用。

xeg_gles_extension.h

XEngine扩展特性查询接口(GLES)。

xeg_gles_neural_upscale.h

XEngine空域AI超分特性接口,推荐超分倍率为[1.0, 1.5]。使用此头文件中的接口前需要通过HMS_XEG_GetString接口查询XEG_NEURAL_UPSCALE_EXTENSION_NAME扩展可用。

xeg_gles_spatial_upscale.h

XEngine空域GPU超分特性GLES接口。使用此头文件的接口前需要通过HMS_XEG_GetString接口查询XEG_SPATIAL_UPSCALE_EXTENSION_NAME扩展可用。

xeg_vulkan_adaptive_vrs.h

XEngine Adaptive VRS特性Vulkan接口。使用此头文件的接口前需要通过HMS_XEG_EnumerateDeviceExtensionProperties接口查询XEG_ADAPTIVE_VRS_EXTENSION_NAME扩展可用。

xeg_vulkan_extension.h

XEngine扩展特性查询接口(Vulkan)。

xeg_vulkan_spatial_upscale.h

XEngine空域GPU超分特性Vulkan接口。使用此头文件的接口前需要通过HMS_XEG_EnumerateDeviceExtensionProperties接口查询XEG_SPATIAL_UPSCALE_EXTENSION_NAME扩展可用。

xeg_vulkan_temporal_upscale.h

XEngine时域AI超分特性接口,推荐超分倍率为[1.25, 2.0]。使用此头文件中的接口前需要通过HMS_XEG_EnumerateDeviceExtensionProperties接口查询XEG_TEMPORAL_UPSCALE_EXTENSION_NAME扩展可用。

[h2]结构体

名称

描述

struct XEG_AdaptiveVRSCreateInfo

此结构体描述创建XEG_AdaptiveVRS对象的参数信息,当结构体中的信息变化时,需要创建新的XEG_AdaptiveVRS对象。

struct XEG_AdaptiveVRSDescription

此结构体描述下发绘制着色率纹理命令需要的参数信息,每一帧都需要进行更新。

struct XEG_ExtensionProperties

此结构体描述通过HMS_XEG_EnumerateDeviceExtensionProperties接口查询到的XEngine扩展特性集合。

struct XEG_SpatialUpscaleCreateInfo

此结构体描述创建XEG_SpatialUpscale对象的信息,当结构体中的信息变化时,需要创建新的XEG_SpatialUpscale对象。

struct XEG_SpatialUpscaleDescription

此结构体描述下发空域GPU超分渲染命令时需要的图像信息。

struct XEG_TemporalUpscaleCreateInfo

此结构体描述创建XEG_TemporalUpscale对象的信息。当结构体中的信息变化时,需要创建新的XEG_TemporalUpscale对象。

struct XEG_TemporalUpscaleDescription

此结构体描述下发时域AI超分渲染命令时的输入信息。

[h2]宏定义

名称

描述

XEG_spatial_upscale 1

XEngine空域GPU超分扩展特性宏定义。

XEG_SPATIAL_UPSCALE_VERSION 1

XEngine空域GPU超分扩展特性版本号。

XEG_SPATIAL_UPSCALE_EXTENSION_NAME "XEG_spatial_upscale"

XEngine空域GPU超分扩展特性名称。

XEG_neural_upscale 1

XEngine空域AI超分扩展特性宏定义。

XEG_NEURAL_UPSCALE_VERSION 1

XEngine空域AI超分扩展特性版本号。

XEG_NEURAL_UPSCALE_EXTENSION_NAME "XEG_neural_upscale"

XEngine空域AI超分扩展特性名称。

XEG_temporal_upscale 1

XEngine时域AI超分扩展特性宏定义。

XEG_TEMPORAL_UPSCALE_VERSION 1

XEngine时域AI超分扩展特性版本号。

XEG_TEMPORAL_UPSCALE_EXTENSION_NAME "XEG_temporal_upscale"

XEngine时域AI超分扩展特性名称。

XEG_adaptive_vrs 1

XEngine自适应VRS扩展特性宏定义。

XEG_ADAPTIVE_VRS_VERSION 1

XEngine自适应VRS扩展特性版本号。

XEG_ADAPTIVE_VRS_EXTENSION_NAME "XEG_adaptive_vrs"

XEngine自适应VRS扩展特性名称。

XEG_ADAPTIVE_VRS_INPUT_SIZE 0x1U

用于设置HMS_XEG_AdaptiveVRSParameter接口的INPUT_SIZE参数,表示上一帧渲染管线最终渲染的图像宽度和高度。

XEG_ADAPTIVE_VRS_INPUT_REGION 0x2U

用于设置HMS_XEG_AdaptiveVRSParameter接口的INPUT_REGION参数,表示上一帧渲染管线最终渲染的图像区域。

XEG_ADAPTIVE_VRS_TEXEL_SIZE 0x3U

用于设置HMS_XEG_AdaptiveVRSParameter接口的TEXEL_SIZE参数。

XEG_ADAPTIVE_VRS_ERROR_SENSITIVITY 0x4U

用于设置HMS_XEG_AdaptiveVRSParameter接口的ERROR_SENSITIVITY参数,表示控制生成着色率图像的阈值。该值越大,平均着色率越小,即性能会越好但画质会劣化。建议取值范围为[0, 1]。

XEG_ADAPTIVE_VRS_FLIP 0x5U

用于设置HMS_XEG_AdaptiveVRSParameter接口的FLIP参数,该参数用于控制是否执行图像上下翻转。

XEG_EXTENSIONS 0x01U

作为HMS_XEG_GetString接口的入参,以获取XEngine支持的GLES扩展特性。

XEG_NEURAL_UPSCALE_SCISSOR 0x1U

用于通过HMS_XEG_NeuralUpscaleParameter接口设置超分的裁剪窗口参数,裁剪窗口用于确定对输入图像采样的区域。

XEG_NEURAL_UPSCALE_SHARPNESS 0x2U

用于通过HMS_XEG_NeuralUpscaleParameter接口设置超分的锐化度参数,锐化度的建议取值范围为[0, 1]。

XEG_NEURAL_UPSCALE_INPUT_HANDLE 0x4U

用于通过HMS_XEG_NeuralUpscaleParameter接口设置与超分输入纹理关联的OH_NativeBuffer handle。

XEG_SPATIAL_UPSCALE_SCISSOR 0x1U

用于设置HMS_XEG_SpatialUpscaleParameter接口的SCISSOR参数。

XEG_SPATIAL_UPSCALE_SHARPNESS 0x2U

用于设置HMS_XEG_SpatialUpscaleParameter接口的SHARPNESS参数。

XEG_MAX_EXTENSION_NAME_SIZE 256

XEngine扩展特性名称支持的最大长度。

[h2]类型定义

名称

描述

typedef void(GL_APIENTRYP PFN_HMS_XEG_ADAPTIVEVRSPARAMETER) (GLenum pname, GLvoid *param)

设置自适应VRS输入参数的函数指针定义。

typedef void(GL_APIENTRYP PFN_HMS_XEG_DISPATCHADAPTIVEVRS) (GLfloat *reprojectionMatrix, GLuint inputColorImage, GLuint inputDepthImage, GLuint shadingRateImage)

计算着色率图像的函数指针定义。

typedef void(GL_APIENTRYP PFN_HMS_XEG_APPLYADAPTIVEVRS) (GLuint shadingRateImage)

将着色率图像应用到渲染目标中的函数指针定义。

typedef const GLubyte *(GL_APIENTRYP PFN_HMS_XEG_GETSTRING) (GLenum name)

XEngine GLES扩展特性查询接口函数指针定义。

typedef void(GL_APIENTRYP PFN_HMS_XEG_NEURALUPSCALEPARAMETER) (GLenum pname, GLvoid *param)

设置空域AI超分输入参数的函数指针定义。

typedef void(GL_APIENTRYP PFN_HMS_XEG_RENDERNEURALUPSCALE) (GLuint inputTexture)

执行空域AI超分渲染命令的函数指针定义。

typedef void(GL_APIENTRYP PFN_HMS_XEG_SPATIALUPSCALEPARAMETER) (GLenum pname, GLvoid *param)

设置空域GPU超分输入参数的函数指针定义。

typedef void(GL_APIENTRYP PFN_HMS_XEG_RENDERSPATIALUPSCALE) (GLuint inputTexture)

执行空域GPU超分渲染命令的函数指针定义。

VK_DEFINE_HANDLE(XEG_AdaptiveVRS)

XEG_AdaptiveVRS的句柄。

typedef struct XEG_AdaptiveVRSCreateInfo XEG_AdaptiveVRSCreateInfo

此结构体描述创建XEG_AdaptiveVRS对象的参数信息,当结构体中的信息变化时,需要创建新的XEG_AdaptiveVRS对象。

typedef struct XEG_AdaptiveVRSDescription XEG_AdaptiveVRSDescription

此结构体描述下发绘制着色率纹理命令需要的参数信息,每一帧都需要进行更新。

typedef VkResult(VKAPI_PTR * PFN_HMS_XEG_CreateAdaptiveVRS) (VkDevice device, const XEG_AdaptiveVRSCreateInfo *pXegAdaptiveVRSCreateInfo, XEG_AdaptiveVRS *pXegAdaptiveVRS)

创建XEG_AdaptiveVRS对象的函数指针定义。

typedef void(VKAPI_PTR * PFN_HMS_XEG_CmdDispatchAdaptiveVRS) (VkCommandBuffer commandBuffer, XEG_AdaptiveVRS xegAdaptiveVRS, XEG_AdaptiveVRSDescription *pXegAdaptiveVRSDescription)

执行计算自适应可变着色率命令的函数指针定义。

typedef void(VKAPI_PTR * PFN_HMS_XEG_DestroyAdaptiveVRS) (XEG_AdaptiveVRS xegAdaptiveVRS)

销毁XEG_AdaptiveVRS对象的函数指针定义。

typedef struct XEG_ExtensionProperties XEG_ExtensionProperties

此结构体描述通过HMS_XEG_EnumerateDeviceExtensionProperties接口查询到的XEngine扩展特性集合。

typedef VkResult(VKAPI_PTR * PFN_HMS_XEG_EnumerateDeviceExtensionProperties) (VkPhysicalDevice physicalDevice, uint32_t *pPropertyCount, XEG_ExtensionProperties *pProperties)

XEngine Vulkan扩展特性查询接口函数指针定义。

VK_DEFINE_HANDLE(XEG_SpatialUpscale)

XEG_SpatialUpscale的句柄。

typedef struct XEG_SpatialUpscaleCreateInfo XEG_SpatialUpscaleCreateInfo

此结构体描述创建XEG_SpatialUpscale对象的信息,当结构体中的信息变化时,需要创建新的XEG_SpatialUpscale对象。

typedef struct XEG_SpatialUpscaleDescription XEG_SpatialUpscaleDescription

此结构体描述下发空域GPU超分渲染命令时需要的图像信息。

typedef VkResult(VKAPI_PTR * PFN_HMS_XEG_CreateSpatialUpscale) (VkDevice device, const XEG_SpatialUpscaleCreateInfo *pXegSpatialUpscaleCreateInfo, XEG_SpatialUpscale *pXegSpatialUpscale)

创建XEG_SpatialUpscale对象的函数指针定义。

typedef void(VKAPI_PTR * PFN_HMS_XEG_CmdRenderSpatialUpscale) (VkCommandBuffer commandBuffer, XEG_SpatialUpscale xegSpatialUpscale, XEG_SpatialUpscaleDescription *pXegSpatialUpscaleDescription)

执行空域GPU超分渲染命令的函数指针定义。

typedef void(VKAPI_PTR * PFN_HMS_XEG_DestroySpatialUpscale) (XEG_SpatialUpscale xegSpatialUpscale)

销毁XEG_SpatialUpscale对象的函数指针定义。

VK_DEFINE_HANDLE(XEG_TemporalUpscale)

XEG_TemporalUpscale的句柄。

typedef struct XEG_TemporalUpscaleCreateInfo XEG_TemporalUpscaleCreateInfo

此结构体描述创建XEG_TemporalUpscale对象的信息。当结构体中的信息变化时,需要创建新的XEG_TemporalUpscale对象。

typedef struct XEG_TemporalUpscaleDescription XEG_TemporalUpscaleDescription

此结构体描述下发时域AI超分渲染命令时的输入信息。

typedef VkResult(VKAPI_ATTR * PFN_HMS_XEG_CreateTemporalUpscale) (VkDevice device, XEG_TemporalUpscaleCreateInfo *pTemporalUpscaleInfo, XEG_TemporalUpscale *pTemporalUpscale)

创建XEG_TemporalUpscale对象的函数指针定义。

typedef void(VKAPI_ATTR * PFN_HMS_XEG_CmdRenderTemporalUpscale) (VkCommandBuffer commandBuffer, XEG_TemporalUpscale temporalUpscale, XEG_TemporalUpscaleDescription *pDescription)

执行时域AI超分渲染命令的函数指针定义。

typedef void(VKAPI_ATTR * PFN_HMS_XEG_DestroyTemporalUpscale) (XEG_TemporalUpscale temporalUpscale)

销毁XEG_TemporalUpscale对象的函数指针定义。

[h2]函数

名称

描述

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)

将着色率图像应用到渲染目标中。

const GLubyte * HMS_XEG_GetString (GLenum name)

XEngine GLES扩展特性查询接口。

GL_APICALL void GL_APIENTRY HMS_XEG_NeuralUpscaleParameter (GLenum pname, GLvoid *param)

设置空域AI超分输入参数。

GL_APICALL void GL_APIENTRY HMS_XEG_RenderNeuralUpscale (GLuint inputTexture)

执行空域AI超分渲染命令。

GL_APICALL void GL_APIENTRY HMS_XEG_SpatialUpscaleParameter (GLenum pname, GLvoid *param)

设置空域GPU超分输入参数。

GL_APICALL void GL_APIENTRY HMS_XEG_RenderSpatialUpscale (GLuint inputTexture)

执行空域GPU超分渲染命令。

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)

执行计算自适应可变着色率命令。

VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroyAdaptiveVRS (XEG_AdaptiveVRS xegAdaptiveVRS)

销毁XEG_AdaptiveVRS对象。

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_CreateSpatialUpscale (VkDevice device, const XEG_SpatialUpscaleCreateInfo *pXegSpatialUpscaleCreateInfo, XEG_SpatialUpscale *pXegSpatialUpscale)

创建XEG_SpatialUpscale对象。

VKAPI_ATTR void VKAPI_CALL HMS_XEG_CmdRenderSpatialUpscale (VkCommandBuffer commandBuffer, XEG_SpatialUpscale xegSpatialUpscale, XEG_SpatialUpscaleDescription *pXegSpatialUpscaleDescription)

执行空域GPU超分渲染命令。

VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroySpatialUpscale (XEG_SpatialUpscale xegSpatialUpscale)

销毁XEG_SpatialUpscale对象。

VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CreateTemporalUpscale (VkDevice device, XEG_TemporalUpscaleCreateInfo *pTemporalUpscaleInfo, XEG_TemporalUpscale *pTemporalUpscale)

创建XEG_TemporalUpscale对象。

VKAPI_ATTR void VKAPI_CALL HMS_XEG_CmdRenderTemporalUpscale (VkCommandBuffer commandBuffer, XEG_TemporalUpscale temporalUpscale, XEG_TemporalUpscaleDescription *pDescription)

执行时域AI超分渲染命令。

VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroyTemporalUpscale (XEG_TemporalUpscale temporalUpscale)

销毁XEG_TemporalUpscale对象。

宏定义说明

[h2]XEG_adaptive_vrs

#define XEG_adaptive_vrs   1

描述

XEngine自适应VRS扩展特性宏定义。

起始版本: 5.0.0(12)

[h2]XEG_ADAPTIVE_VRS_ERROR_SENSITIVITY

#define XEG_ADAPTIVE_VRS_ERROR_SENSITIVITY   0x4U

描述

用于设置HMS_XEG_AdaptiveVRSParameter接口的ERROR_SENSITIVITY参数,表示控制生成着色率图像的阈值。该值越大,平均着色率越小,即性能会越好但画质会劣化。建议取值范围为[0, 1]。

使用此宏定义时通过HMS_XEG_AdaptiveVRSParameter接口设置ERROR_SENSITIVITY参数,向接口传递的param必须是GLfloat指针,否则将产生未定义行为,如渲染效果不正确或者程序崩溃。 可选参数,默认为0.5。

起始版本: 5.0.0(12)

[h2]XEG_ADAPTIVE_VRS_EXTENSION_NAME

#define XEG_ADAPTIVE_VRS_EXTENSION_NAME   "XEG_adaptive_vrs"

描述

XEngine自适应VRS扩展特性名称。

起始版本: 5.0.0(12)

[h2]XEG_ADAPTIVE_VRS_FLIP

#define XEG_ADAPTIVE_VRS_FLIP   0x5U

描述

用于设置HMS_XEG_AdaptiveVRSParameter接口的FLIP参数,该参数用于控制是否执行图像上下翻转。

使用此宏定义时通过HMS_XEG_AdaptiveVRSParameter接口设置FLIP参数,向接口传递的param必须是GLboolean指针,否则将产生未定义行为,如渲染效果不正确或者程序崩溃。 可选参数,默认为false。true表示执行翻转,false表示不执行翻转。

起始版本: 5.0.0(12)

[h2]XEG_ADAPTIVE_VRS_INPUT_REGION

#define XEG_ADAPTIVE_VRS_INPUT_REGION   0x2U

描述

用于设置HMS_XEG_AdaptiveVRSParameter接口的INPUT_REGION参数,表示上一帧渲染管线最终渲染的图像区域。

使用此宏定义时通过HMS_XEG_AdaptiveVRSParameter接口设置INPUT_REGION参数,向接口传递的param必须是长度为4的GLuint类型数组,依次为渲染图像区域的左下角坐标和图像宽高,否则将产生未定义行为,如渲染效果不正确或者程序崩溃。 可选参数,默认为[0, 0, INPUT_SIZE[0], INPUT_SIZE[1]]。

起始版本: 5.0.0(12)

[h2]XEG_ADAPTIVE_VRS_INPUT_SIZE

#define XEG_ADAPTIVE_VRS_INPUT_SIZE   0x1U

描述

用于设置HMS_XEG_AdaptiveVRSParameter接口的INPUT_SIZE参数,表示上一帧渲染管线最终渲染的图像宽度和高度。

使用此宏定义时通过HMS_XEG_AdaptiveVRSParameter接口设置INPUT_SIZE参数,向接口传递的param必须是长度为2的GLsizei类型数组,否则将产生未定义行为,如渲染效果不正确或者程序崩溃。 必填参数,且需要保证和HMS_XEG_DispatchAdaptiveVRS的inputColorImage宽高相同。

起始版本: 5.0.0(12)

[h2]XEG_ADAPTIVE_VRS_TEXEL_SIZE

#define XEG_ADAPTIVE_VRS_TEXEL_SIZE   0x3U

描述

用于设置HMS_XEG_AdaptiveVRSParameter接口的TEXEL_SIZE参数。

使用此宏定义时通过HMS_XEG_AdaptiveVRSParameter接口设置TEXEL_SIZE参数,向接口传递的param必须是长度为2的GLsizei类型数组,依次为TEXEL_WIDTH和TEXEL_HEIGHT,否则将产生未定义行为,如渲染效果不正确或者程序崩溃。 可选参数,默认为[8, 8],支持[8, 8]和[16, 16]。

起始版本: 5.0.0(12)

[h2]XEG_ADAPTIVE_VRS_VERSION

#define XEG_ADAPTIVE_VRS_VERSION   1

描述

XEngine自适应VRS扩展特性版本号。

起始版本: 5.0.0(12)

[h2]XEG_EXTENSIONS

#define XEG_EXTENSIONS   0x01U

描述

作为HMS_XEG_GetString接口的入参,以获取XEngine支持的GLES扩展特性。

起始版本: 5.0.0(12)

[h2]XEG_MAX_EXTENSION_NAME_SIZE

#define XEG_MAX_EXTENSION_NAME_SIZE   256

描述

XEngine扩展特性名称支持的最大长度。

起始版本: 5.0.0(12)

[h2]XEG_neural_upscale

#define XEG_neural_upscale   1

描述

XEngine空域AI超分扩展特性宏定义。

起始版本: 5.0.0(12)

[h2]XEG_NEURAL_UPSCALE_EXTENSION_NAME

#define XEG_NEURAL_UPSCALE_EXTENSION_NAME   "XEG_neural_upscale"

描述

XEngine空域AI超分扩展特性名称。

起始版本: 5.0.0(12)

[h2]XEG_NEURAL_UPSCALE_INPUT_HANDLE

#define XEG_NEURAL_UPSCALE_INPUT_HANDLE   0x4U

描述

用于通过HMS_XEG_NeuralUpscaleParameter接口设置与超分输入纹理关联的OH_NativeBuffer handle。

使用此宏定义设置超分输入参数时,向接口传递的param值必须是与向HMS_XEG_RenderNeuralUpscale接口传递的inputTexture纹理参数对应的合法的OH_NativeBuffer handle,否则将产生未定义行为,如渲染效果不正确或者程序崩溃。 必选参数。

起始版本: 5.0.0(12)

[h2]XEG_NEURAL_UPSCALE_SCISSOR

#define XEG_NEURAL_UPSCALE_SCISSOR   0x1U

描述

用于通过HMS_XEG_NeuralUpscaleParameter接口设置超分的裁剪窗口参数,裁剪窗口用于确定对输入图像采样的区域。

使用此宏定义设置裁剪窗口参数时,向接口传递的param值必须是长度为4的无符号整数数组,否则将产生未定义行为,如渲染效果不正确或者程序崩溃。数组中的值依次为:x, y, width, height,其中x、y确定裁剪窗口的左下角,width、height分别确定裁剪窗口的宽和高。 可选参数,不设置裁剪窗口参数时的默认值为(0, 0, 输入纹理的宽, 输入纹理的高)。

起始版本: 5.0.0(12)

[h2]XEG_NEURAL_UPSCALE_SHARPNESS

#define XEG_NEURAL_UPSCALE_SHARPNESS   0x2U

描述

用于通过HMS_XEG_NeuralUpscaleParameter接口设置超分的锐化度参数,锐化度的建议取值范围为[0, 1]。

使用此宏定义设置超分的锐化度参数时,向接口传递的param值必须是指向一个float值的合法指针,否则将产生未定义行为,如渲染效果不正确或者程序崩溃。 可选参数,不设置锐化度参数时的默认值为0.2。

起始版本: 5.0.0(12)

[h2]XEG_NEURAL_UPSCALE_VERSION

#define XEG_NEURAL_UPSCALE_VERSION   1

描述

XEngine空域AI超分扩展特性版本号。

起始版本: 5.0.0(12)

[h2]XEG_spatial_upscale

#define XEG_spatial_upscale   1

描述

XEngine空域GPU超分扩展特性宏定义。

起始版本: 5.0.0(12)

[h2]XEG_SPATIAL_UPSCALE_EXTENSION_NAME

#define XEG_SPATIAL_UPSCALE_EXTENSION_NAME   "XEG_spatial_upscale"

描述

XEngine空域GPU超分扩展特性名称。

起始版本: 5.0.0(12)

[h2]XEG_SPATIAL_UPSCALE_SCISSOR

#define XEG_SPATIAL_UPSCALE_SCISSOR   0x1U

描述

用于设置HMS_XEG_SpatialUpscaleParameter接口的SCISSOR参数。

使用此宏定义时通过HMS_XEG_SpatialUpscaleParameter接口设置SCISSOR参数,向接口传递的param值必须是指向长度为4的无符号整数数组的指针,否则将产生未定义行为,如渲染效果不正确或者程序崩溃。 SCISSOR四个值依次为裁剪窗口的左下角点的x与y的值和裁剪窗口的宽高。

起始版本: 5.0.0(12)

[h2]XEG_SPATIAL_UPSCALE_SHARPNESS

#define XEG_SPATIAL_UPSCALE_SHARPNESS   0x2U

描述

用于设置HMS_XEG_SpatialUpscaleParameter接口的SHARPNESS参数。

使用此宏定义时通过HMS_XEG_SpatialUpscaleParameter接口设置SHARPNESS参数,向接口传递的param值必须是指向float类型的指针。SHARPNESS参数建议取值范围为[0, 1],否则将产生未定义行为,如渲染效果不正确或者程序崩溃。 SHARPNESS参数越大锐化效果越强,不同风格图像锐化值需要调整,否则会导致过度锐化现象,如出现大量噪点。

起始版本: 5.0.0(12)

[h2]XEG_SPATIAL_UPSCALE_VERSION

#define XEG_SPATIAL_UPSCALE_VERSION   1

描述

XEngine空域GPU超分扩展特性版本号。

起始版本: 5.0.0(12)

[h2]XEG_temporal_upscale

#define XEG_temporal_upscale   1

描述

XEngine时域AI超分扩展特性宏定义。

起始版本: 5.0.0(12)

[h2]XEG_TEMPORAL_UPSCALE_EXTENSION_NAME

#define XEG_TEMPORAL_UPSCALE_EXTENSION_NAME   "XEG_temporal_upscale"

描述

XEngine时域AI超分扩展特性名称。

起始版本: 5.0.0(12)

[h2]XEG_TEMPORAL_UPSCALE_VERSION

#define XEG_TEMPORAL_UPSCALE_VERSION   1

描述

XEngine时域AI超分扩展特性版本号。

起始版本: 5.0.0(12)

类型定义说明

[h2]PFN_HMS_XEG_ADAPTIVEVRSPARAMETER

typedef void(GL_APIENTRYP PFN_HMS_XEG_ADAPTIVEVRSPARAMETER) (GLenum pname, GLvoid *param)

描述

设置自适应VRS输入参数的函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

pname

输入参数的枚举名,取值范围是XEG_ADAPTIVE_VRS_INPUT_SIZE、XEG_ADAPTIVE_VRS_INPUT_REGION、XEG_ADAPTIVE_VRS_TEXEL_SIZE、XEG_ADAPTIVE_VRS_ERROR_SENSITIVITY、XEG_ADAPTIVE_VRS_FLIP。

param

输入参数值,取值详见输入参数枚举名的说明。

[h2]PFN_HMS_XEG_APPLYADAPTIVEVRS

typedef void(GL_APIENTRYP PFN_HMS_XEG_APPLYADAPTIVEVRS) (GLuint shadingRateImage)

描述

将着色率图像应用到渲染目标中的函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

shadingRateImage

计算得到的着色率图像,传入0表示关闭自适应VRS。

[h2]PFN_HMS_XEG_CmdDispatchAdaptiveVRS

typedef void(VKAPI_PTR * PFN_HMS_XEG_CmdDispatchAdaptiveVRS) (VkCommandBuffer commandBuffer, XEG_AdaptiveVRS xegAdaptiveVRS, XEG_AdaptiveVRSDescription *pXegAdaptiveVRSDescription)

描述

执行计算自适应可变着色率命令的函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

commandBuffer

当前记录命令的VkCommandBuffer,此VkCommandBuffer必须被提交到vkQueueSubmit,否则无法执行。

xegAdaptiveVRS

已创建的XEG_AdaptiveVRS对象。

pXegAdaptiveVRSDescription

下发命令的参数结构体XEG_AdaptiveVRSDescription的指针,不允许为空。

[h2]PFN_HMS_XEG_CmdRenderSpatialUpscale

typedef void(VKAPI_PTR * PFN_HMS_XEG_CmdRenderSpatialUpscale) (VkCommandBuffer commandBuffer, XEG_SpatialUpscale xegSpatialUpscale, XEG_SpatialUpscaleDescription *pXegSpatialUpscaleDescription)

描述

执行空域GPU超分渲染命令的函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

commandBuffer

当前记录命令的VkCommandBuffer,此VkCommandBuffer必须被提交到vkQueueSubmit,否则无法执行超分。

xegSpatialUpscale

已创建的XEG_SpatialUpscale对象。

pXegSpatialUpscaleDescription

渲染命令的参数结构体XEG_SpatialUpscaleDescription的指针,不允许为空。

[h2]PFN_HMS_XEG_CmdRenderTemporalUpscale

typedef void(VKAPI_ATTR * PFN_HMS_XEG_CmdRenderTemporalUpscale) (VkCommandBuffer commandBuffer, XEG_TemporalUpscale temporalUpscale, XEG_TemporalUpscaleDescription *pDescription)

描述

执行时域AI超分渲染命令的函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

commandBuffer

Vulkan命令缓冲对象,需要是Primary类型。

temporalUpscale

已创建的XEG_TemporalUpscale对象。

pDescription

超分渲染输入信息结构体XEG_TemporalUpscaleDescription的指针,不允许为空。

[h2]PFN_HMS_XEG_CreateAdaptiveVRS

typedef VkResult(VKAPI_PTR * PFN_HMS_XEG_CreateAdaptiveVRS) (VkDevice device, const XEG_AdaptiveVRSCreateInfo *pXegAdaptiveVRSCreateInfo, XEG_AdaptiveVRS *pXegAdaptiveVRS)

描述

创建XEG_AdaptiveVRS对象的函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

device

必须是当前使用的VkDevice。

pXegAdaptiveVRSCreateInfo

结构体XEG_AdaptiveVRSCreateInfo的指针,不允许为空。

pXegAdaptiveVRS

指向句柄的指针,创建的XEG_AdaptiveVRS在此句柄中返回。

返回:

返回一个VkResult类型的错误码,返回值为VK_SUCCESS表示执行成功。

[h2]PFN_HMS_XEG_CreateSpatialUpscale

typedef VkResult(VKAPI_PTR * PFN_HMS_XEG_CreateSpatialUpscale) (VkDevice device, const XEG_SpatialUpscaleCreateInfo *pXegSpatialUpscaleCreateInfo, XEG_SpatialUpscale *pXegSpatialUpscale)

描述

创建XEG_SpatialUpscale对象的函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

device

必须是当前使用的VkDevice。

pXegSpatialUpscaleCreateInfo

结构体XEG_SpatialUpscaleCreateInfo的指针,不允许为空。

pXegSpatialUpscale

指向句柄的指针,创建的XEG_SpatialUpscale在此句柄中返回。

返回:

返回一个VkResult类型的错误码,返回值为VK_SUCCESS表示执行成功。

[h2]PFN_HMS_XEG_CreateTemporalUpscale

typedef VkResult(VKAPI_ATTR * PFN_HMS_XEG_CreateTemporalUpscale) (VkDevice device, XEG_TemporalUpscaleCreateInfo *pTemporalUpscaleInfo, XEG_TemporalUpscale *pTemporalUpscale)

描述

创建XEG_TemporalUpscale对象的函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

device

必须是当前使用的VkDevice。

pTemporalUpscaleInfo

超分实例句柄创建信息结构体XEG_TemporalUpscaleCreateInfo的指针,不允许为空。

pTemporalUpscale

指向句柄的指针,创建的XEG_TemporalUpscale在此句柄中返回。

返回:

返回一个VkResult类型的错误码,返回值为VK_SUCCESS表示执行成功。

[h2]PFN_HMS_XEG_DestroyAdaptiveVRS

typedef void(VKAPI_PTR * PFN_HMS_XEG_DestroyAdaptiveVRS) (XEG_AdaptiveVRS xegAdaptiveVRS)

描述

销毁XEG_AdaptiveVRS对象的函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

xegAdaptiveVRS

已创建的XEG_AdaptiveVRS对象。

[h2]PFN_HMS_XEG_DestroySpatialUpscale

typedef void(VKAPI_PTR * PFN_HMS_XEG_DestroySpatialUpscale) (XEG_SpatialUpscale xegSpatialUpscale)

描述

销毁XEG_SpatialUpscale对象的函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

xegSpatialUpscale

已创建的XEG_SpatialUpscale对象。

[h2]PFN_HMS_XEG_DestroyTemporalUpscale

typedef void(VKAPI_ATTR * PFN_HMS_XEG_DestroyTemporalUpscale) (XEG_TemporalUpscale temporalUpscale)

描述

销毁XEG_TemporalUpscale对象的函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

temporalUpscale

需要销毁的XEG_TemporalUpscale对象。

[h2]PFN_HMS_XEG_DISPATCHADAPTIVEVRS

typedef void(GL_APIENTRYP PFN_HMS_XEG_DISPATCHADAPTIVEVRS) (GLfloat *reprojectionMatrix, GLuint inputColorImage, GLuint inputDepthImage, GLuint shadingRateImage)

描述

计算着色率图像的函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

reprojectionMatrix

当前帧和上一帧进行计算的结果矩阵的指针,计算公式为:(上一帧投影矩阵* 上一帧的观察矩阵)* ((当前帧的投影矩阵* 当前帧的观察矩阵)的逆矩阵),矩阵必须是4*4列主序的矩阵。可选参数,非空时画质较优。

inputColorImage

上一帧渲染管线最终渲染结果颜色附件纹理ID。

inputDepthImage

当前帧渲染管线最终渲染结果深度附件纹理ID。

shadingRateImage

用于生成着色率图信息的纹理ID,需用户创建并输入。

纹理类型需要是GL_TEXTURE_2D且mipLevels为1。

[h2]PFN_HMS_XEG_EnumerateDeviceExtensionProperties

typedef VkResult(VKAPI_PTR * PFN_HMS_XEG_EnumerateDeviceExtensionProperties) (VkPhysicalDevice physicalDevice, uint32_t *pPropertyCount, XEG_ExtensionProperties *pProperties)

描述

XEngine Vulkan扩展特性查询接口函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

physicalDevice

当前使用的Vulkan物理设备。

pPropertyCount

查询或传入扩展特性的数量,当pProperties为nullptr时返回当前支持的XEngine扩展特性数量。 当传入的propertyCount大于或等于真实支持的XEngine扩展特性数量时,通过pProperties返回查询信息,返回结果为VK_SUCCESS。 当传入的propertyCount小于真实支持的XEngine扩展特性数量时,通过pProperties返回查询信息,但返回结果为VK_INCOMPLETE。

pProperties

查询到的XEngine扩展特性,通过结构体XEG_ExtensionProperties指针返回。

返回:

返回VkResult类型错误码,查询成功时返回值为VK_SUCCESS。 当pProperties不为nullptr且传入的propertyCount小于实际支持的XEngine扩展特性数量时返回值为VK_INCOMPLETE,表示查询特性不完整。

[h2]PFN_HMS_XEG_GETSTRING

typedef const GLubyte*(GL_APIENTRYP PFN_HMS_XEG_GETSTRING) (GLenum name)

描述

XEngine GLES扩展特性查询接口函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

name

输入参数的枚举名,取值范围为XEG_EXTENSIONS。

返回:

当参数为XEG_EXTENSIONS时,返回XEngine支持的空格分隔的扩展列表,注意扩展名不包含空格字符。查询结果异常则返回空。

[h2]PFN_HMS_XEG_NEURALUPSCALEPARAMETER

typedef void(GL_APIENTRYP PFN_HMS_XEG_NEURALUPSCALEPARAMETER) (GLenum pname, GLvoid *param)

描述

设置空域AI超分输入参数的函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

pname

输入参数的枚举名,取值范围为XEG_NEURAL_UPSCALE_SCISSOR、XEG_NEURAL_UPSCALE_SHARPNESS、XEG_NEURAL_UPSCALE_INPUT_HANDLE。

param

输入参数的值,取值详见输入参数枚举名的说明。

[h2]PFN_HMS_XEG_RENDERNEURALUPSCALE

typedef void(GL_APIENTRYP PFN_HMS_XEG_RENDERNEURALUPSCALE) (GLuint inputTexture)

描述

执行空域AI超分渲染命令的函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

inputTexture

超分输入纹理。输入纹理是GL_TEXTURE_2D类型且mipLevels为1,纹理的宽度取值范围是[448, 1728],否则可能会引起AI推理结果错误。此输入纹理必须是由OH_NativeBuffer创建的,并需要在调用此接口前将OH_NativeBuffer对应的handle设置为超分的输入参数,详见接口HMS_XEG_NeuralUpscaleParameter。

[h2]PFN_HMS_XEG_RENDERSPATIALUPSCALE

typedef void(GL_APIENTRYP PFN_HMS_XEG_RENDERSPATIALUPSCALE) (GLuint inputTexture)

描述

执行空域GPU超分渲染命令的函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

inputTexture

指定输入纹理,输入纹理是GL_TEXTURE_2D类型且mipLevels为1。此纹理必须在调用此接口前创建好,否则会导致渲染失败,如黑屏问题。

[h2]PFN_HMS_XEG_SPATIALUPSCALEPARAMETER

typedef void(GL_APIENTRYP PFN_HMS_XEG_SPATIALUPSCALEPARAMETER) (GLenum pname, GLvoid *param)

描述

设置空域GPU超分输入参数的函数指针定义。

起始版本: 5.0.0(12)

参数:

名称

描述

pname

输入参数的枚举名,取值范围为XEG_SPATIAL_UPSCALE_SCISSOR、XEG_SPATIAL_UPSCALE_SHARPNESS。

param

输入参数值,取值详见输入参数枚举名的说明。

[h2]XEG_AdaptiveVRS

VK_DEFINE_HANDLE(XEG_AdaptiveVRS)

描述

XEG_AdaptiveVRS的句柄。

起始版本: 5.0.0(12)

[h2]XEG_AdaptiveVRSCreateInfo

typedef struct XEG_AdaptiveVRSCreateInfo XEG_AdaptiveVRSCreateInfo

描述

此结构体描述创建XEG_AdaptiveVRS对象的参数信息,当结构体中的信息变化时,需要创建新的XEG_AdaptiveVRS对象。

起始版本: 5.0.0(12)

[h2]XEG_AdaptiveVRSDescription

typedef struct XEG_AdaptiveVRSDescription XEG_AdaptiveVRSDescription

描述

此结构体描述下发绘制着色率纹理命令需要的参数信息,每一帧都需要进行更新。

起始版本: 5.0.0(12)

[h2]XEG_ExtensionProperties

typedef struct XEG_ExtensionProperties XEG_ExtensionProperties

描述

此结构体描述通过HMS_XEG_EnumerateDeviceExtensionProperties接口查询到的XEngine扩展特性集合。

起始版本: 5.0.0(12)

[h2]XEG_SpatialUpscale

VK_DEFINE_HANDLE(XEG_SpatialUpscale)

描述

XEG_SpatialUpscale的句柄。

起始版本: 5.0.0(12)

[h2]XEG_SpatialUpscaleCreateInfo

typedef struct XEG_SpatialUpscaleCreateInfo XEG_SpatialUpscaleCreateInfo

描述

此结构体描述创建XEG_SpatialUpscale对象的信息,当结构体中的信息变化时,需要创建新的XEG_SpatialUpscale对象。

起始版本: 5.0.0(12)

[h2]XEG_SpatialUpscaleDescription

typedef struct XEG_SpatialUpscaleDescription XEG_SpatialUpscaleDescription

描述

此结构体描述下发空域GPU超分渲染命令时需要的图像信息。

起始版本: 5.0.0(12)

[h2]XEG_TemporalUpscale

VK_DEFINE_HANDLE(XEG_TemporalUpscale)

描述

XEG_TemporalUpscale的句柄。

起始版本: 5.0.0(12)

[h2]XEG_TemporalUpscaleCreateInfo

typedef struct XEG_TemporalUpscaleCreateInfo XEG_TemporalUpscaleCreateInfo

描述

此结构体描述创建XEG_TemporalUpscale对象的信息。当结构体中的信息变化时,需要创建新的XEG_TemporalUpscale对象。

起始版本: 5.0.0(12)

[h2]XEG_TemporalUpscaleDescription

typedef struct XEG_TemporalUpscaleDescription XEG_TemporalUpscaleDescription

描述

此结构体描述下发时域AI超分渲染命令时的输入信息。

起始版本: 5.0.0(12)

函数说明

[h2]HMS_XEG_AdaptiveVRSParameter()

GL_APICALL void GL_APIENTRY HMS_XEG_AdaptiveVRSParameter (GLenum pname, GLvoid * param)

描述

设置自适应VRS的参数。

起始版本: 5.0.0(12)

参数:

名称

描述

pname

输入参数的枚举名,取值范围是XEG_ADAPTIVE_VRS_INPUT_SIZE、XEG_ADAPTIVE_VRS_INPUT_REGION、XEG_ADAPTIVE_VRS_TEXEL_SIZE、XEG_ADAPTIVE_VRS_ERROR_SENSITIVITY、XEG_ADAPTIVE_VRS_FLIP。

param

输入参数值,取值详见输入参数枚举名的说明。

[h2]HMS_XEG_ApplyAdaptiveVRS()

GL_APICALL void GL_APIENTRY HMS_XEG_ApplyAdaptiveVRS (GLuint shadingRateImage)

描述

将着色率图像应用到渲染目标中。

起始版本: 5.0.0(12)

参数:

名称

描述

shadingRateImage

计算得到的着色率图像,传入0表示关闭自适应VRS。

[h2]HMS_XEG_CmdDispatchAdaptiveVRS()

VKAPI_ATTR void VKAPI_CALL HMS_XEG_CmdDispatchAdaptiveVRS (VkCommandBuffer commandBuffer, XEG_AdaptiveVRS xegAdaptiveVRS, XEG_AdaptiveVRSDescription * pXegAdaptiveVRSDescription)

描述

执行计算自适应可变着色率命令。

起始版本: 5.0.0(12)

参数:

名称

描述

commandBuffer

当前记录命令的VkCommandBuffer,此VkCommandBuffer必须被提交到vkQueueSubmit,否则无法执行。

xegAdaptiveVRS

已创建的XEG_AdaptiveVRS对象。

pXegAdaptiveVRSDescription

下发命令的参数结构体XEG_AdaptiveVRSDescription的指针,不允许为空。

[h2]HMS_XEG_CmdRenderSpatialUpscale()

VKAPI_ATTR void VKAPI_CALL HMS_XEG_CmdRenderSpatialUpscale (VkCommandBuffer commandBuffer, XEG_SpatialUpscale xegSpatialUpscale, XEG_SpatialUpscaleDescription * pXegSpatialUpscaleDescription)

描述

执行空域GPU超分渲染命令。

起始版本: 5.0.0(12)

参数:

名称

描述

commandBuffer

当前记录命令的VkCommandBuffer,此VkCommandBuffer必须被提交到vkQueueSubmit,否则无法执行超分。

xegSpatialUpscale

已创建的XEG_SpatialUpscale对象。

pXegSpatialUpscaleDescription

渲染命令的参数结构体XEG_SpatialUpscaleDescription的指针,不允许为空。

[h2]HMS_XEG_CmdRenderTemporalUpscale()

VKAPI_ATTR void VKAPI_CALL HMS_XEG_CmdRenderTemporalUpscale (VkCommandBuffer commandBuffer, XEG_TemporalUpscale temporalUpscale, XEG_TemporalUpscaleDescription * pDescription)

描述

执行时域AI超分渲染命令。

起始版本: 5.0.0(12)

参数:

名称

描述

commandBuffer

Vulkan命令缓冲对象,需要是Primary类型。

temporalUpscale

已创建的XEG_TemporalUpscale对象。

pDescription

超分渲染输入信息结构体XEG_TemporalUpscaleDescription的指针,不允许为空。

[h2]HMS_XEG_CreateAdaptiveVRS()

VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CreateAdaptiveVRS (VkDevice device, XEG_AdaptiveVRSCreateInfo * pXegAdaptiveVRSCreateInfo, XEG_AdaptiveVRS * pXegAdaptiveVRS)

描述

创建XEG_AdaptiveVRS对象。

起始版本: 5.0.0(12)

参数:

名称

描述

device

必须是当前使用的VkDevice。

pXegAdaptiveVRSCreateInfo

结构体XEG_AdaptiveVRSCreateInfo的指针,不允许为空。

pXegAdaptiveVRS

指向句柄的指针,创建的XEG_AdaptiveVRS在此句柄中返回。

返回:

返回一个VkResult类型的错误码,返回值为VK_SUCCESS表示执行成功。

[h2]HMS_XEG_CreateSpatialUpscale()

VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CreateSpatialUpscale (VkDevice device, const XEG_SpatialUpscaleCreateInfo * pXegSpatialUpscaleCreateInfo, XEG_SpatialUpscale * pXegSpatialUpscale)

描述

创建XEG_SpatialUpscale对象。

起始版本: 5.0.0(12)

参数:

名称

描述

device

必须是当前使用的VkDevice。

pXegSpatialUpscaleCreateInfo

结构体XEG_SpatialUpscaleCreateInfo的指针,不允许为空。

pXegSpatialUpscale

指向句柄的指针,创建的XEG_SpatialUpscale在此句柄中返回。

返回:

返回一个VkResult类型的错误码,返回值为VK_SUCCESS表示执行成功。

[h2]HMS_XEG_CreateTemporalUpscale()

VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CreateTemporalUpscale (VkDevice device, XEG_TemporalUpscaleCreateInfo * pTemporalUpscaleInfo, XEG_TemporalUpscale * pTemporalUpscale)

描述

创建XEG_TemporalUpscale对象。

起始版本: 5.0.0(12)

参数:

名称

描述

device

必须是当前使用的VkDevice。

pTemporalUpscaleInfo

超分实例句柄创建信息结构体XEG_TemporalUpscaleCreateInfo的指针,不允许为空。

pTemporalUpscale

指向句柄的指针,创建的XEG_TemporalUpscale在此句柄中返回。

返回:

返回一个VkResult类型的错误码,返回值为VK_SUCCESS表示执行成功。

[h2]HMS_XEG_DestroyAdaptiveVRS()

VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroyAdaptiveVRS (XEG_AdaptiveVRS xegAdaptiveVRS)

描述

销毁XEG_AdaptiveVRS对象。

起始版本: 5.0.0(12)

参数:

名称

描述

xegAdaptiveVRS

已创建的XEG_AdaptiveVRS对象。

[h2]HMS_XEG_DestroySpatialUpscale()

VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroySpatialUpscale (XEG_SpatialUpscale xegSpatialUpscale)

描述

销毁XEG_SpatialUpscale对象。

起始版本: 5.0.0(12)

参数:

名称

描述

xegSpatialUpscale

已创建的XEG_SpatialUpscale对象。

[h2]HMS_XEG_DestroyTemporalUpscale()

VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroyTemporalUpscale (XEG_TemporalUpscale temporalUpscale)

描述

销毁XEG_TemporalUpscale对象。

起始版本: 5.0.0(12)

参数:

名称

描述

temporalUpscale

需要销毁的XEG_TemporalUpscale对象。

[h2]HMS_XEG_DispatchAdaptiveVRS()

GL_APICALL void GL_APIENTRY HMS_XEG_DispatchAdaptiveVRS (GLfloat * reprojectionMatrix, GLuint inputColorImage, GLuint inputDepthImage, GLuint shadingRateImage)

描述

计算着色率图像。

起始版本: 5.0.0(12)

参数:

名称

描述

reprojectionMatrix

当前帧和上一帧进行计算的结果矩阵的指针,计算公式为:(上一帧投影矩阵* 上一帧的观察矩阵)* ((当前帧的投影矩阵* 当前帧的观察矩阵)的逆矩阵),矩阵必须是4*4列主序的矩阵。可选参数,非空时画质较优。

inputColorImage

上一帧渲染管线最终渲染结果颜色附件纹理ID。

inputDepthImage

当前帧渲染管线最终渲染结果深度附件纹理ID。

shadingRateImage

用于生成着色率图信息的纹理ID,需用户创建并输入。

纹理类型需要是GL_TEXTURE_2D且mipLevels为1。

[h2]HMS_XEG_EnumerateDeviceExtensionProperties()

VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_EnumerateDeviceExtensionProperties (VkPhysicalDevice physicalDevice, uint32_t * pPropertyCount, XEG_ExtensionProperties * pProperties)

描述

XEngine Vulkan扩展特性查询接口。

起始版本: 5.0.0(12)

参数:

名称

描述

physicalDevice

当前使用的Vulkan物理设备。

pPropertyCount

查询或传入扩展特性的数量,当pProperties为nullptr时返回当前支持的XEngine扩展特性数量。 当传入的propertyCount大于或等于真实支持的XEngine扩展特性数量时,通过pProperties返回查询信息,返回结果为VK_SUCCESS。 当传入的propertyCount小于真实支持的XEngine扩展特性数量时,通过pProperties返回查询信息,但返回结果为VK_INCOMPLETE。

pProperties

查询到的XEngine扩展特性,通过结构体XEG_ExtensionProperties指针返回。

返回:

返回VkResult类型错误码,查询成功时返回值为VK_SUCCESS。 当pProperties不为nullptr且传入的propertyCount小于实际支持的XEngine扩展特性数量时返回值为VK_INCOMPLETE,表示查询特性不完整。

[h2]HMS_XEG_GetString()

const GLubyte* HMS_XEG_GetString (GLenum name)

描述

XEngine GLES扩展特性查询接口。

起始版本: 5.0.0(12)

参数:

名称

描述

name

输入参数的枚举名,取值范围为XEG_EXTENSIONS。

返回:

当参数为XEG_EXTENSIONS时,返回XEngine支持的空格分隔的扩展列表,注意扩展名不包含空格字符。查询结果异常则返回空。

[h2]HMS_XEG_NeuralUpscaleParameter()

GL_APICALL void GL_APIENTRY HMS_XEG_NeuralUpscaleParameter (GLenum pname, GLvoid * param)

描述

设置空域AI超分输入参数。

起始版本: 5.0.0(12)

参数:

名称

描述

pname

输入参数的枚举名,取值范围为XEG_NEURAL_UPSCALE_SCISSOR、XEG_NEURAL_UPSCALE_SHARPNESS、XEG_NEURAL_UPSCALE_INPUT_HANDLE。

param

输入参数值,取值详见输入参数枚举名的说明。

[h2]HMS_XEG_RenderNeuralUpscale()

GL_APICALL void GL_APIENTRY HMS_XEG_RenderNeuralUpscale (GLuint inputTexture)

描述

执行空域AI超分渲染命令。

起始版本: 5.0.0(12)

参数:

名称

描述

inputTexture

超分输入纹理。输入纹理是GL_TEXTURE_2D类型且mipLevels为1,纹理的宽度取值范围是[448, 1728],否则可能会引起AI推理结果错误。此输入纹理必须是由OH_NativeBuffer创建的,并需要在调用此接口前将OH_NativeBuffer对应的handle设置为超分的输入参数,详见接口HMS_XEG_NeuralUpscaleParameter。

[h2]HMS_XEG_RenderSpatialUpscale()

GL_APICALL void GL_APIENTRY HMS_XEG_RenderSpatialUpscale (GLuint inputTexture)

描述

执行空域GPU超分渲染命令。

起始版本: 5.0.0(12)

参数:

名称

描述

inputTexture

指定输入纹理,输入纹理是GL_TEXTURE_2D类型且mipLevels为1。此纹理必须在调用此接口前创建好,否则会导致渲染失败,如黑屏问题。

[h2]HMS_XEG_SpatialUpscaleParameter()

GL_APICALL void GL_APIENTRY HMS_XEG_SpatialUpscaleParameter (GLenum pname, GLvoid * param)

描述

设置空域GPU超分输入参数。

起始版本: 5.0.0(12)

参数:

名称

描述

pname

输入参数的枚举名,取值范围为XEG_SPATIAL_UPSCALE_SCISSOR、XEG_SPATIAL_UPSCALE_SHARPNESS。

param

输入参数值,取值详见输入参数枚举名的说明。