XEngine

概述

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

系统能力： SystemCapability.Graphic.XEngine

起始版本： 5.0.0(12)

汇总

[h2]文件

[h2]结构体

[h2]宏定义

[h2]类型定义

[h2]枚举

[h2]函数

宏定义说明

[h2]XEG_adaptive_vrs

#define XEG_adaptive_vrs   1

描述

XEngine自适应VRS(Variable Rate Shading)扩展特性宏定义。

起始版本： 5.0.0(12)

[h2]XEG_ADAPTIVE_VRS_ERROR_SENSITIVITY

#define XEG_ADAPTIVE_VRS_ERROR_SENSITIVITY   0x4U

描述

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

使用此宏定义时通过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(Variable Rate Shading)扩展特性名称。

起始版本： 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支持的OpenGL ES扩展特性。

起始版本： 5.0.0(12)

[h2]XEG_HPS_RADIX_SORT_EXTENSION_NAME

#define XEG_HPS_RADIX_SORT_EXTENSION_NAME   "XEG_hps_radix_sort"

描述

XEngine 高性能基数排序扩展特性名称。

起始版本： 6.0.0(20)

[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_UPSCALE2_EXTENSION_NAME

#define XEG_NEURAL_UPSCALE2_EXTENSION_NAME   "XEG_neural_upscale2"

描述

XEngine空域AI超分（版本2）扩展特性名称。

起始版本： 26.0.0

[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.0, 1.0]。

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

可选参数，不设置锐化度参数时的默认值为0.2。

起始版本： 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，否则将产生未定义行为，如渲染效果不正确或者程序崩溃。

当XEG_NEURAL_UPSCALE_EXTENSION_NAME扩展可用时，该参数为必选参数。

当XEG_NEURAL_UPSCALE2_EXTENSION_NAME扩展可用时，不需要设置该参数。

起始版本： 5.0.0(12)

[h2]XEG_NEURAL_UPSCALE_VERSION

#define XEG_NEURAL_UPSCALE_VERSION   1

描述

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

起始版本： 5.0.0(12)

[h2]XEG_RT_REFLECTION_EXTENSION_NAME

#define XEG_RT_REFLECTION_EXTENSION_NAME   "XEG_rt_reflection"

描述

XEngine光线追踪反射扩展特性名称。

起始版本： 6.0.0(20)

[h2]XEG_RT_SHADOW_AO_EXTENSION_NAME

#define XEG_RT_SHADOW_AO_EXTENSION_NAME   "XEG_rt_shadow_ao"

描述

XEngine光线追踪阴影和环境光遮蔽扩展特性名称。

起始版本： 6.0.0(20)

[h2]XEG_RTGI_EXTENSION_NAME

#define XEG_RTGI_EXTENSION_NAME   "XEG_rtgi"

描述

XEngine光线追踪全局光照扩展特性名称。

起始版本： 6.0.0(20)

[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.0, 1.0]，否则将产生未定义行为，如渲染效果不正确或者程序崩溃。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_DEPTH_REVERSED

#define XEG_TEMPORAL_UPSCALE_DEPTH_REVERSED   0x3U

描述

用于通过HMS_XEG_TemporalUpscaleParameter接口设置是否存在深度反转。true表示存在深度反转，false表示不存在深度反转。

使用此宏定义设置是否存在深度反转时，向接口传递的param值必须是指向一个GLboolean值的合法指针，否则将产生未定义行为，如渲染效果不正确或者程序崩溃。必选参数。

起始版本： 6.0.0(20)

[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_INPUT_SIZE

#define XEG_TEMPORAL_UPSCALE_INPUT_SIZE   0x1U

描述

用于通过HMS_XEG_TemporalUpscaleParameter接口设置超分输入纹理的真实宽高。

使用此宏定义设置输入宽高时，向接口传递的param值必须是长度为2的无符号整数数组，否则将产生未定义行为，如渲染效果不正确或者程序崩溃。数组中的值依次为：width, height。width和height分别确定输入纹理的宽和高。必选参数。

起始版本： 6.0.0(20)

[h2]XEG_TEMPORAL_UPSCALE_JITTER_NUM

#define XEG_TEMPORAL_UPSCALE_JITTER_NUM   0x2U

描述

用于通过HMS_XEG_TemporalUpscaleParameter接口设置相机抖动的周期数，取值范围为[4, 16]，推荐8。

使用此宏定义设置相机抖动的周期数时，向接口传递的param值必须是指向一个GLuint值的合法指针，否则将产生未定义行为，如渲染效果不正确或者程序崩溃。必选参数。

起始版本： 6.0.0(20)

[h2]XEG_TEMPORAL_UPSCALE_RESET_HISTORY

#define XEG_TEMPORAL_UPSCALE_RESET_HISTORY   0x4U

描述

用于通过HMS_XEG_TemporalUpscaleParameter接口设置是否重置历史帧数据，true表示重置，false表示不重置。在历史帧未使用超分，并且当前帧开始使用超分的情况下建议设置为true。

使用此宏定义设置是否重置历史帧数据时，向接口传递的param值必须是指向一个GLboolean值的合法指针，否则将产生未定义行为，如渲染效果不正确或者程序崩溃。必选参数。

起始版本： 6.0.0(20)

[h2]XEG_TEMPORAL_UPSCALE_STEADY_LEVEL

#define XEG_TEMPORAL_UPSCALE_STEADY_LEVEL   0x5U

描述

用于通过HMS_XEG_TemporalUpscaleParameter接口设置画面偏向当前帧（鬼影少但可能存在闪烁）还是历史帧（鬼影多但是更稳定）的平衡程度。取值范围为[0.0, 1.0]，如果该值不在以上范围内，则会发生未定义行为，例如渲染效果不正确或程序崩溃，值越大越偏向历史帧。建议根据实际需求选择合适的值，例如在需要减少鬼影时可设置为较小值，需要减少闪烁可以设置为较大值，推荐值为0.5。

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

起始版本： 6.0.0(20)

[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(Variable Rate Shading)输入参数的函数指针定义。

起始版本： 5.0.0(12)

参数:

[h2]PFN_HMS_XEG_APPLYADAPTIVEVRS

typedef void(GL_APIENTRYP PFN_HMS_XEG_APPLYADAPTIVEVRS) (GLuint shadingRateImage)

描述

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

起始版本： 5.0.0(12)

参数:

[h2]PFN_HMS_XEG_CmdDispatchAdaptiveVRS

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

描述

执行计算自适应VRS命令的函数指针定义。

起始版本： 5.0.0(12)

参数:

[h2]PFN_HMS_XEG_CmdRadixSortHPS

typedef VkResult(VKAPI_PTR *PFN_HMS_XEG_CmdRadixSortHPS) (VkCommandBuffer commandBuffer, XEG_HPS hps, const XEG_HPSRadixSortDescription *pDescription)

描述

录制HPS排序命令的函数指针定义，使用此接口前需要通过HMS_XEG_EnumerateDeviceExtensionProperties接口查询是否支持XEG_HPS_RADIX_SORT_EXTENSION_NAME扩展。

起始版本： 6.0.0(20)

参数:

返回：

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

[h2]PFN_HMS_XEG_CmdRenderRTGI

typedef VkResult(VKAPI_PTR *PFN_HMS_XEG_CmdRenderRTGI) (VkCommandBuffer commandBuffer, XEG_RTGI rtGI, const void *pDescription)

描述

执行渲染命令的函数指针定义。

起始版本： 6.0.0(20)

参数:

返回：

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

[h2]PFN_HMS_XEG_CmdRenderRTReflection

typedef VkResult (VKAPI_ATTR *PFN_HMS_XEG_CmdRenderRTReflection)(VkCommandBuffer commandBuffer, XEG_RTReflection rtReflection, const void *pDescription)

描述

录制计算RT反射命中信息命令的函数指针定义。

起始版本： 6.0.0(20)

参数:

[h2]PFN_HMS_XEG_CmdRenderRTVisibleMask

typedef VkResult(VKAPI_PTR *PFN_HMS_XEG_CmdRenderRTVisibleMask) (VkCommandBuffer commandBuffer, XEG_RTVisibleMask rtVisibleMask, const void *pDescription)

描述

录制光线追踪VisibleMask渲染命令的函数指针定义。

起始版本： 6.0.0(20)

参数:

返回：

VkResult类型的错误码，值为VK_SUCCESS时表示执行成功。

[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)

参数:

[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)

参数:

[h2]PFN_HMS_XEG_CmdRenderNeuralUpscale

typedef VkResult (VKAPI_PTR *PFN_HMS_XEG_CmdRenderNeuralUpscale) (VkCommandBuffer commandBuffer, XEG_NeuralUpscale neuralUpscale, const XEG_NeuralUpscaleDescription *pDescription)

描述

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

起始版本： 26.0.0

参数:

返回：

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

[h2]PFN_HMS_XEG_CmdSetSynchronization

typedef VkResult(VKAPI_PTR *PFN_HMS_XEG_CmdSetSynchronization) (VkCommandBuffer commandBuffer, const void *xegHandle)

描述

设置同步信号，等待渲染结果写入指定图像的函数指针定义。使用RTGI特性时，为等待GI渲染结果到写入指定图像。

起始版本： 6.0.0(20)

参数:

返回：

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

[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)

参数:

返回：

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

[h2]PFN_HMS_XEG_CreateHPS

typedef VkResult(VKAPI_PTR *PFN_HMS_XEG_CreateHPS) (VkDevice device, const XEG_HPSCreateInfo *pCreateInfo, XEG_HPS *pHps)

描述

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

起始版本： 6.0.0(20)

参数:

返回：

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

[h2]PFN_HMS_XEG_CreateRTGI

typedef VkResult(VKAPI_PTR *PFN_HMS_XEG_CreateRTGI) (VkDevice device, const void *pCreateInfo, XEG_RTGI *pRtGI)

描述

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

起始版本： 6.0.0(20)

参数:

返回：

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

[h2]PFN_HMS_XEG_CreateRTReflection

typedef VkResult(VKAPI_ATTR *PFN_HMS_XEG_CreateRTReflection) (VkDevice device, const void *pCreateInfo, XEG_RTReflection *pRtReflection)

描述

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

起始版本： 6.0.0(20)

参数:

返回：

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

[h2]PFN_HMS_XEG_CreateRTVisibleMask

typedef VkResult(VKAPI_PTR *PFN_HMS_XEG_CreateRTVisibleMask) (VkDevice device, const void *pCreateInfo, XEG_RTVisibleMask *pRTVisibleMask)

描述

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

起始版本： 6.0.0(20)

参数:

返回：

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)

参数:

返回：

返回一个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)

参数:

返回：

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

[h2]PFN_HMS_XEG_CreateNeuralUpscale

typedef VkResult(VKAPI_PTR *PFN_HMS_XEG_CreateNeuralUpscale) (VkDevice device, const XEG_NeuralUpscaleCreateInfo *pCreateInfo, XEG_NeuralUpscale *pNeuralUpscale)

描述

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

起始版本： 26.0.0

参数:

返回：

返回一个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)

参数:

[h2]PFN_HMS_XEG_DestroyHPS

typedef void(VKAPI_PTR *PFN_HMS_XEG_DestroyHPS) (XEG_HPS hps)

描述

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

起始版本： 6.0.0(20)

参数:

[h2]PFN_HMS_XEG_DestroyRTGI

typedef void(VKAPI_PTR *PFN_HMS_XEG_DestroyRTGI) (XEG_RTGI rtGI)

描述

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

起始版本： 6.0.0(20)

参数:

[h2]PFN_HMS_XEG_DestroyRTReflection

typedef void(VKAPI_ATTR *PFN_HMS_XEG_DestroyRTReflection) (XEG_RTReflection rtReflection)

描述

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

起始版本： 6.0.0(20)

参数:

[h2]PFN_HMS_XEG_DestroyRTVisibleMask

typedef void(VKAPI_PTR *PFN_HMS_XEG_DestroyRTVisibleMask) (XEG_RTVisibleMask rtVisibleMask)

描述

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

起始版本： 6.0.0(20)

参数:

[h2]PFN_HMS_XEG_DestroySpatialUpscale

typedef void(VKAPI_PTR *PFN_HMS_XEG_DestroySpatialUpscale) (XEG_SpatialUpscale xegSpatialUpscale)

描述

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

起始版本： 5.0.0(12)

参数:

[h2]PFN_HMS_XEG_DestroyTemporalUpscale

typedef void(VKAPI_ATTR *PFN_HMS_XEG_DestroyTemporalUpscale) (XEG_TemporalUpscale temporalUpscale)

描述

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

起始版本： 5.0.0(12)

参数:

[h2]PFN_HMS_XEG_DestroyNeuralUpscale

typedef void(VKAPI_PTR *PFN_HMS_XEG_DestroyNeuralUpscale)(XEG_NeuralUpscale neuralUpscale)

描述

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

起始版本： 26.0.0

参数:

[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)

参数:

纹理类型需要是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)

参数:

返回：

返回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 OpenGL ES扩展特性查询接口函数指针定义。

起始版本： 5.0.0(12)

参数:

返回：

当参数为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)

参数:

[h2]PFN_HMS_XEG_RENDERNEURALUPSCALE

typedef void(GL_APIENTRYP PFN_HMS_XEG_RENDERNEURALUPSCALE) (GLuint inputTexture)

描述

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

起始版本： 5.0.0(12)

参数:

[h2]PFN_HMS_XEG_RENDERSPATIALUPSCALE

typedef void(GL_APIENTRYP PFN_HMS_XEG_RENDERSPATIALUPSCALE) (GLuint inputTexture)

描述

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

起始版本： 5.0.0(12)

参数:

[h2]PFN_HMS_XEG_RenderTemporalUpscale

typedef void(GL_APIENTRYP PFN_HMS_XEG_RenderTemporalUpscale) (GLuint inputTexture, GLuint depthTexture, GLuint motionVectorTexture, GLuint dynamicMaskTexture, GLfloat jitterX, GLfloat jitterY)

描述

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

起始版本： 6.0.0(20)

参数:

[h2]PFN_HMS_XEG_SPATIALUPSCALEPARAMETER

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

描述

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

起始版本： 5.0.0(12)

参数:

[h2]PFN_HMS_XEG_TemporalUpscaleParameter

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

描述

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

起始版本： 6.0.0(20)

参数:

[h2]PFN_HMS_XEG_ControlDisplaySeparationStatusCallback

typedef void(*PFN_HMS_XEG_ControlDisplaySeparationStatusCallback) (XEG_ControlDisplaySeparationStatus status);

描述

控显分离特性监听函数的函数指针定义。

设备行为差异： 该接口只在部分折叠手机上可正常使用，在其他设备中不可交互。

起始版本： 26.0.0

参数:

[h2]PFN_HMS_XEG_SetControlDisplaySeparationStatusListener

typedef bool(*PFN_HMS_XEG_SetControlDisplaySeparationStatusListener) (PFN_HMS_XEG_ControlDisplaySeparationStatusCallback callback);

描述

设置控显分离特性全局唯一监听函数的函数指针定义。

设备行为差异： 该接口只在部分折叠手机上可正常使用，在其他设备中不可交互。

起始版本： 26.0.0

参数:

返回：

返回设置是否成功，true表示设置成功，false代表设置失败，只有当前设备支持控显分离特性并且应用在module.json中注册了控显分离特性才返回成功。

[h2]PFN_HMS_XEG_RemoveControlDisplaySeparationStatusListener

typedef void(*PFN_HMS_XEG_RemoveControlDisplaySeparationStatusListener) ();

描述

移除控显分离特性全局唯一监听函数的函数指针定义。

设备行为差异： 该接口只在部分折叠手机上可正常使用，在其他设备中不可交互。

起始版本： 26.0.0

[h2]PFN_HMS_XEG_SetControlDisplaySeparationActive

typedef bool(*PFN_HMS_XEG_SetControlDisplaySeparationActive) (bool flag);

描述

设置控显分离特性使能开关的函数指针定义。

设备行为差异： 该接口只在部分折叠手机上可正常使用，在其他设备中不可交互。

起始版本： 26.0.0

参数:

返回：

返回设置是否成功，true表示设置成功，false代表设置失败，设置控显分离特性使能成功的前提是必须设置控显分离特性监听函数并且监听函数回调的状态为可用。

[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_DenoiseQualityMode

typedef enum XEG_DenoiseQualityMode XEG_DenoiseQualityMode

描述

去噪质量模式枚举。

起始版本： 6.0.0(20)

[h2]XEG_ExtensionProperties

typedef struct XEG_ExtensionProperties XEG_ExtensionProperties

描述

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

起始版本： 5.0.0(12)

[h2]XEG_HPS

VK_DEFINE_HANDLE(XEG_HPS)

描述

XEG_HPS的句柄。

起始版本： 6.0.0(20)

[h2]XEG_HPSCreateInfo

typedef struct XEG_HPSCreateInfo XEG_HPSCreateInfo

描述

此结构体描述创建XEG_HPS对象的信息。

起始版本： 6.0.0(20)

[h2]XEG_HPSRadixSort

typedef struct XEG_HPSRadixSort XEG_HPSRadixSort

描述

此结构体描述HPS基数排序扩展结构信息。

起始版本： 6.0.0(20)

[h2]XEG_HPSRadixSortDescription

typedef struct XEG_HPSRadixSortDescription XEG_HPSRadixSortDescription

描述

此结构体描述使用XEG_HPS_RADIX_SORT_EXTENSION_NAME扩展进行排序时所需的信息。

起始版本： 6.0.0(20)

[h2]XEG_RTGI

VK_DEFINE_HANDLE(XEG_RTGI)

描述

XEG_RTGI的句柄。

起始版本： 6.0.0(20)

[h2]XEG_RTGIQualityMode

typedef enum XEG_RTGIQualityMode XEG_RTGIQualityMode

描述

输出图像质量模式的枚举。

起始版本： 6.0.0(20)

[h2]XEG_RTReflection

VK_DEFINE_HANDLE(XEG_RTReflection)

描述

XEG_RTReflection的句柄。

起始版本： 6.0.0(20)

[h2]XEG_RTReflectionCreateInfo

typedef struct XEG_RTReflectionCreateInfo XEG_RTReflectionCreateInfo

描述

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

起始版本： 6.0.0(20)

[h2]XEG_RTReflectionDescription

typedef struct XEG_RTReflectionDescription XEG_RTReflectionDescription

描述

此结构体描述下发光线求交命令时的输入信息。

起始版本： 6.0.0(20)

[h2]XEG_RTVisibleMask

VK_DEFINE_HANDLE(XEG_RTVisibleMask)

描述

XEG_RTVisibleMask的句柄。表示光线追踪VisibleMask特性实例，支持阴影和环境光遮蔽效果。

起始版本： 6.0.0(20)

[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_StructureType

typedef enum XEG_StructureType XEG_StructureType

描述

XEngine结构体类型的枚举。

起始版本： 6.0.0(20)

[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]XEG_TraversalMode

typedef enum XEG_TraversalMode XEG_TraversalMode

描述

遍历模式枚举。

起始版本： 6.0.0(20)

[h2]XEG_NeuralUpscale

VK_DEFINE_HANDLE(XEG_NeuralUpscale)

描述

XEG_NeuralUpscale的句柄。

起始版本： 26.0.0

[h2]XEG_NeuralUpscaleCreateInfo

typedef struct XEG_NeuralUpscaleCreateInfo XEG_NeuralUpscaleCreateInfo

描述

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

起始版本： 26.0.0

[h2]XEG_NeuralUpscaleDescription

typedef struct XEG_NeuralUpscaleDescription XEG_NeuralUpscaleDescription

描述

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

起始版本： 26.0.0

[h2]XEG_ControlDisplaySeparationStatus

typedef enum XEG_ControlDisplaySeparationStatus XEG_ControlDisplaySeparationStatus

描述

控显分离当前的状态信息的枚举

设备行为差异： 该接口只在部分折叠手机上可正常使用，在其他设备中不可交互。

起始版本： 26.0.0

枚举类型说明

[h2]XEG_DenoiseQualityMode

enum XEG_DenoiseQualityMode

描述

去噪质量模式枚举。

起始版本： 6.0.0(20)

[h2]XEG_RTGIQualityMode

enum XEG_RTGIQualityMode

描述

输出图像质量模式的枚举。

起始版本： 6.0.0(20)

[h2]XEG_StructureType

enum XEG_StructureType

描述

XEngine结构体类型的枚举。

起始版本： 6.0.0(20)

[h2]XEG_TraversalMode

enum XEG_TraversalMode

描述

遍历模式枚举。

起始版本： 6.0.0(20)

[h2]XEG_ControlDisplaySeparationStatus

enum XEG_ControlDisplaySeparationStatus

描述

控显分离当前的状态信息的枚举

设备行为差异： 该接口只在部分折叠手机上可正常使用，在其他设备中不可交互。

起始版本： 26.0.0

函数说明

[h2]HMS_XEG_AdaptiveVRSParameter()

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

描述

设置自适应VRS(Variable Rate Shading)的参数。

起始版本： 5.0.0(12)

参数:

[h2]HMS_XEG_ApplyAdaptiveVRS()

GL_APICALL void GL_APIENTRY HMS_XEG_ApplyAdaptiveVRS (GLuint shadingRateImage)

描述

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

起始版本： 5.0.0(12)

参数:

[h2]HMS_XEG_CmdDispatchAdaptiveVRS()

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

描述

执行计算自适应VRS命令。

起始版本： 5.0.0(12)

参数:

[h2]HMS_XEG_CmdRadixSortHPS()

VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CmdRadixSortHPS (VkCommandBuffer commandBuffer, XEG_HPS hps, const XEG_HPSRadixSortDescription * pDescription)

描述

录制HPS排序命令，使用此接口前需要通过HMS_XEG_EnumerateDeviceExtensionProperties接口查询是否支持XEG_HPS_RADIX_SORT_EXTENSION_NAME扩展。

起始版本： 6.0.0(20)

参数:

返回：

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

[h2]HMS_XEG_CmdRenderRTGI()

VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CmdRenderRTGI (VkCommandBuffer commandBuffer, XEG_RTGI rtGI, const void * pDescription)

描述

执行渲染命令。

起始版本： 6.0.0(20)

参数:

返回：

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

[h2]HMS_XEG_CmdRenderRTReflection()

VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CmdRenderRTReflection (VkCommandBuffer commandBuffer, XEG_RTReflection rtReflection, const void * pDescription)

描述

录制计算RT反射命中信息命令。

起始版本： 6.0.0(20)

参数:

[h2]HMS_XEG_CmdRenderRTVisibleMask()

VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CmdRenderRTVisibleMask (VkCommandBuffer commandBuffer, XEG_RTVisibleMask rtVisibleMask, const void * pDescription)

描述

录制光线追踪VisibleMask渲染命令。

起始版本： 6.0.0(20)

参数:

返回：

VkResult类型的错误码，值为VK_SUCCESS时表示执行成功。

[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)

参数:

[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)

参数:

[h2]HMS_XEG_CmdRenderNeuralUpscale()

VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CmdRenderNeuralUpscale (VkCommandBuffer commandBuffer, XEG_NeuralUpscale neuralUpscale, const XEG_NeuralUpscaleDescription *pDescription)

描述

录制空域AI超分渲染命令。

起始版本： 26.0.0

参数:

返回：

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

[h2]HMS_XEG_CmdSetSynchronization()

VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CmdSetSynchronization (VkCommandBuffer commandBuffer, const void * xegHandle )

描述

设置同步信号，等待渲染结果写入指定图像。使用RTGI特性时，为等待GI渲染结果写入指定图像。

起始版本： 6.0.0(20)

参数:

返回：

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

[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)

参数:

返回：

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

[h2]HMS_XEG_CreateHPS()

VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CreateHPS (VkDevice device, const XEG_HPSCreateInfo * pCreateInfo, XEG_HPS * pHps )

描述

创建XEG_HPS对象。

起始版本： 6.0.0(20)

参数:

返回：

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

[h2]HMS_XEG_CreateRTGI()

VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CreateRTGI (VkDevice device, const void * pCreateInfo, XEG_RTGI * pRtGI )

描述

创建XEG_RTGI对象。

起始版本： 6.0.0(20)

参数:

返回：

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

[h2]HMS_XEG_CreateRTReflection()

VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CreateRTReflection (VkDevice device, const void * pCreateInfo, XEG_RTReflection * pRtReflection )

描述

创建XEG_RTReflection对象。

起始版本： 6.0.0(20)

参数:

返回：

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

[h2]HMS_XEG_CreateRTVisibleMask()

VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CreateRTVisibleMask (VkDevice device, const void * pCreateInfo, XEG_RTVisibleMask * pRTVisibleMask )

描述

创建XEG_RTVisibleMask对象。

起始版本： 6.0.0(20)

参数:

返回：

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)

参数:

返回：

返回一个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)

参数:

返回：

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

[h2]HMS_XEG_CreateNeuralUpscale()

VKAPI_ATTR VkResult VKAPI_CALL HMS_XEG_CreateNeuralUpscale (VkDevice device, const XEG_NeuralUpscaleCreateInfo * pCreateInfo, XEG_NeuralUpscale * pNeuralUpscale)

描述

创建XEG_NeuralUpscale对象。

起始版本： 26.0.0

参数:

返回：

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

[h2]HMS_XEG_DestroyAdaptiveVRS()

VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroyAdaptiveVRS (XEG_AdaptiveVRS xegAdaptiveVRS)

描述

销毁XEG_AdaptiveVRS对象。

起始版本： 5.0.0(12)

参数:

[h2]HMS_XEG_DestroyHPS()

VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroyHPS (XEG_HPS hps)

描述

销毁XEG_HPS对象。

起始版本： 6.0.0(20)

参数:

[h2]HMS_XEG_DestroyRTGI()

VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroyRTGI (XEG_RTGI rtGI)

描述

销毁XEG_RTGI对象。

起始版本： 6.0.0(20)

参数:

[h2]HMS_XEG_DestroyRTReflection()

VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroyRTReflection (XEG_RTReflection rtReflection)

描述

销毁XEG_RTReflection对象。

起始版本： 6.0.0(20)

参数:

[h2]HMS_XEG_DestroyRTVisibleMask()

VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroyRTVisibleMask (XEG_RTVisibleMask rtVisibleMask)

描述

销毁XEG_RTVisibleMask对象。

起始版本： 6.0.0(20)

参数:

[h2]HMS_XEG_DestroySpatialUpscale()

VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroySpatialUpscale (XEG_SpatialUpscale xegSpatialUpscale)

描述

销毁XEG_SpatialUpscale对象。

起始版本： 5.0.0(12)

参数:

[h2]HMS_XEG_DestroyTemporalUpscale()

VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroyTemporalUpscale (XEG_TemporalUpscale temporalUpscale)

描述

销毁XEG_TemporalUpscale对象。

起始版本： 5.0.0(12)

参数:

[h2]HMS_XEG_DestroyNeuralUpscale()

VKAPI_ATTR void VKAPI_CALL HMS_XEG_DestroyNeuralUpscale (XEG_NeuralUpscale neuralUpscale)

描述

销毁XEG_NeuralUpscale对象。

起始版本： 26.0.0

参数:

[h2]HMS_XEG_DispatchAdaptiveVRS()

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

描述

计算着色率图像。

起始版本： 5.0.0(12)

参数:

纹理类型需要是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)

参数:

返回：

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

[h2]HMS_XEG_GetString()

const GLubyte* HMS_XEG_GetString (GLenum name)

描述

XEngine OpenGL ES扩展特性查询接口。

起始版本： 5.0.0(12)

参数:

返回：

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

[h2]HMS_XEG_NeuralUpscaleParameter()

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

描述

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

起始版本： 5.0.0(12)

参数:

[h2]HMS_XEG_RenderNeuralUpscale()

GL_APICALL void GL_APIENTRY HMS_XEG_RenderNeuralUpscale (GLuint inputTexture)

描述

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

起始版本： 5.0.0(12)

参数:

[h2]HMS_XEG_RenderSpatialUpscale()

GL_APICALL void GL_APIENTRY HMS_XEG_RenderSpatialUpscale (GLuint inputTexture)

描述

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

起始版本： 5.0.0(12)

参数:

[h2]HMS_XEG_RenderTemporalUpscale()

GL_APICALL void GL_APIENTRY HMS_XEG_RenderTemporalUpscale (GLuint inputTexture, GLuint depthTexture, GLuint motionVectorTexture, GLuint dynamicMaskTexture, GLfloat jitterX, GLfloat jitterY )

描述

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

起始版本： 6.0.0(20)

参数:

[h2]HMS_XEG_SpatialUpscaleParameter()

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

描述

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

起始版本： 5.0.0(12)

参数:

[h2]HMS_XEG_TemporalUpscaleParameter()

GL_APICALL void GL_APIENTRY HMS_XEG_TemporalUpscaleParameter (GLenum pname, const GLvoid * param)

描述

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

起始版本： 6.0.0(20)

参数:

[h2]HMS_XEG_SetControlDisplaySeparationStatusListener()

bool HMS_XEG_SetControlDisplaySeparationStatusListener(PFN_HMS_XEG_ControlDisplaySeparationStatusCallback callback);

描述

设置控显分离特性全局唯一监听函数。

设备行为差异： 该接口只在部分折叠手机上可正常使用，在其他设备中不可交互。

起始版本： 26.0.0

参数:

返回:

返回设置是否成功，true表示设置成功，false代表设置失败，只有当前设备支持控显分离特性并且应用在module.json中注册了控显分离特性才返回成功。

[h2]HMS_XEG_RemoveControlDisplaySeparationStatusListener()

void HMS_XEG_RemoveControlDisplaySeparationStatusListener();

描述

移除控显分离特性全局唯一监听函数。

设备行为差异： 该接口只在部分折叠手机上可正常使用，在其他设备中不可交互。

起始版本： 26.0.0

[h2]HMS_XEG_SetControlDisplaySeparationActive()

bool HMS_XEG_SetControlDisplaySeparationActive(bool flag);

描述

设置控显分离特性使能开关。

设备行为差异： 该接口只在部分折叠手机上可正常使用，在其他设备中不可交互。

起始版本： 26.0.0

参数:

返回:

返回设置是否成功，true表示设置成功，false代表设置失败，设置控显分离特性使能成功的前提是必须设置控显分离特性监听函数并且监听函数回调的状态为可用。