FidelityFX FSR1

FidelityFX Super Resolution 1 运行时库。

Defines

FFX_FSR1_VERSION_MAJOR

#define FFX_FSR1_VERSION_MAJOR (1)

包含 FSR 1.0 API 后端的接口。

FidelityFX Super Resolution 1.0 主版本。

来源： sdk/include/FidelityFX/host/ffx_fsr1.h (第 38 行, 第 9 列)

FFX_FSR1_VERSION_MINOR

#define FFX_FSR1_VERSION_MINOR (2)

FidelityFX Super Resolution 1.0 次版本。

来源： sdk/include/FidelityFX/host/ffx_fsr1.h (第 43 行, 第 9 列)

FFX_FSR1_VERSION_PATCH

#define FFX_FSR1_VERSION_PATCH (0)

FidelityFX Super Resolution 1.0 补丁版本。

来源： sdk/include/FidelityFX/host/ffx_fsr1.h (第 48 行, 第 9 列)

FFX_FSR1_CONTEXT_COUNT

#define FFX_FSR1_CONTEXT_COUNT 2

FidelityFX Super Resolution 1.0 上下文计数。

定义 FSR1 所需的内部效果上下文数量

来源： sdk/include/FidelityFX/host/ffx_fsr1.h (第 55 行, 第 9 列)

FFX_FSR1_CONTEXT_SIZE

#define FFX_FSR1_CONTEXT_SIZE (27448)

以 32 位值为单位指定的上下文大小。

来源： sdk/include/FidelityFX/host/ffx_fsr1.h (第 60 行, 第 9 列)

函数

ffxFsr1ContextCreate

FFX_API FfxErrorCode ffxFsr1ContextCreate(FfxFsr1Context *pContext, const FfxFsr1ContextDescription *pContextDescription)

根据 `FfxFsr1ContextDescription` 结构体中设置的参数，创建一个 FidelityFX Super Resolution 1.0 上下文。

上下文结构体是与 Super Resolution 1.0 API 交互的主要对象，负责管理 FSR1 算法使用的内部资源。调用此 API 时，将通过回调结构体中的指针进行多次调用。这些回调函数将尝试检索设备功能，并创建 FSR1 帧与帧功能所需的内部资源和管线。根据创建 `FfxFsr1Context` 时使用的具体配置，通过回调函数可能会请求不同的一组资源和管线。

`FfxParallelSortContext` 在使用完毕后应被销毁，通常在应用程序卸载或用户禁用 FSR1 缩放时。要销毁 FSR1 上下文，应调用 `ffxFsr1ContextDestroy`。

参数

pContext (FfxFsr1Context *) – [输出] 指向要填充的 `FfxFsr1Context` 结构的指针。
pContextDescription (const FfxFsr1ContextDescription *) – [输入] 指向 `FfxFsr1ContextDescription` 结构的指针。

返回： FFX_API FfxErrorCode

来源： sdk/include/FidelityFX/host/ffx_fsr1.h (第 198 行, 第 22 列)

ffxFsr1ContextGetGpuMemoryUsage

FFX_API FfxErrorCode ffxFsr1ContextGetGpuMemoryUsage(FfxFsr1Context *pContext, FfxEffectMemoryUsage *pVramUsage)

获取 FidelityFX Super Resolution 上下文的 GPU 内存使用情况。

参数

pContext (FfxFsr1Context *) – [输入] 指向 `FfxFsr1Context` 结构的指针。
pVramUsage (FfxEffectMemoryUsage *) – [输出] 指向 `FfxEffectMemoryUsage` 结构的指针。

返回： FFX_API FfxErrorCode

来源： sdk/include/FidelityFX/host/ffx_fsr1.h (第 211 行, 第 22 列)

ffxFsr1ContextDispatch

FFX_API FfxErrorCode ffxFsr1ContextDispatch(FfxFsr1Context *pContext, const FfxFsr1DispatchDescription *pDispatchDescription)

参数

pContext (FfxFsr1Context *) – [输出] 指向要填充的 `FfxFsr1Context` 结构的指针。
pDispatchDescription (const FfxFsr1DispatchDescription *) – [输入] 指向 `FfxFsr1DispatchDescription` 结构的指针。

返回： FFX_API FfxErrorCode

来源： sdk/include/FidelityFX/host/ffx_fsr1.h (第 224 行, 第 22 列)

ffxFsr1ContextDestroy

FFX_API FfxErrorCode ffxFsr1ContextDestroy(FfxFsr1Context *pContext)

销毁 FidelityFX FSR 1 上下文。

参数

pContext (FfxFsr1Context *) – [输出] 指向要销毁的 `FfxFsr1Context` 结构的指针。

返回： FFX_API FfxErrorCode

来源： sdk/include/FidelityFX/host/ffx_fsr1.h (第 236 行, 第 22 列)

ffxFsr1GetUpscaleRatioFromQualityMode

FFX_API float ffxFsr1GetUpscaleRatioFromQualityMode(FfxFsr1QualityMode qualityMode)

根据质量模式获取缩放比例。

下表列出了质量模式与每维缩放比例的映射。

质量预设
缩放系数

FFX_FSR1_QUALITY_MODE_ULTRA_QUALITY
1.3x

FFX_FSR1_QUALITY_MODE_QUALITY
1.5x

FFX_FSR1_QUALITY_MODE_BALANCED
1.7x

FFX_FSR1_QUALITY_MODE_PERFORMANCE
2.0x

传入无效的 `qualityMode` 将返回 0.0f。

返回值：根据上表，`qualityMode` 的每维缩放比例。

参数

qualityMode (FfxFsr1QualityMode) – [输入] 质量模式预设。

返回值： FFX_API float

来源： sdk/include/FidelityFX/host/ffx_fsr1.h (第 259 行, 第 15 列)

ffxFsr1GetRenderResolutionFromQualityMode

FFX_API FfxErrorCode ffxFsr1GetRenderResolutionFromQualityMode(uint32_t *pRenderWidth, uint32_t *pRenderHeight, uint32_t displayWidth, uint32_t displayHeight, FfxFsr1QualityMode qualityMode)

一个辅助函数，用于根据目标分辨率和期望的质量级别计算渲染分辨率。

此函数将 `ffxFsr1GetUpscaleRatioFromQualityMode` 返回的缩放因子应用于每个维度。

参数

pRenderWidth (uint32_t *) – [输出] 指向 `uint32_t` 的指针，其中将保存计算出的渲染分辨率宽度。
pRenderHeight (uint32_t *) – [输出] 指向 `uint32_t` 的指针，其中将保存计算出的渲染分辨率高度。
displayWidth (uint32_t) – [输入] 目标显示分辨率宽度。
displayHeight (uint32_t) – [输入] 目标显示分辨率高度。
qualityMode (FfxFsr1QualityMode) – [输入] FSR1 缩放的首选质量模式。

返回： FFX_API FfxErrorCode

来源： sdk/include/FidelityFX/host/ffx_fsr1.h (第 281 行, 第 22 列)

ffxFsr1GetEffectVersion

FFX_API FfxVersionNumber ffxFsr1GetEffectVersion()

查询效果版本号。

返回: 构建该效果的 SDK 版本。

返回: FFX_API FfxVersionNumber

来源： sdk/include/FidelityFX/host/ffx_fsr1.h (第 294 行, 第 26 列)

枚举

FfxFsr1Pass

enum FfxFsr1Pass

构成 FSR1 算法的所有通道的枚举。

FSR1 实现为多个计算通道的组合，每个通道计算最终结果的关键部分。每次调用 `FfxFsr1ScheduleGpuJobFunc` 回调函数将对应于 `FfxFsr1Pass` 中的一个通道。有关每个通道的更全面描述，请参阅 FSR1 参考文档。

值

FFX_FSR1_PASS_EASU

FFX_FSR1_PASS_EASU = 0

使用 easu 缩放颜色缓冲区的通道。

FFX_FSR1_PASS_EASU_RCAS

FFX_FSR1_PASS_EASU_RCAS = 1

为 rcas 准备缩放颜色缓冲区的通道。

FFX_FSR1_PASS_RCAS

FFX_FSR1_PASS_RCAS = 2

在缩放后的图像上执行 rcas 锐化的通道。

FFX_FSR1_PASS_COUNT

FSR2 执行的通道数。

来源： sdk/include/FidelityFX/host/ffx_fsr1.h (第 76 行, 第 1 列)

FfxFsr1QualityMode

enum FfxFsr1QualityMode

FidelityFX Super Resolution 1 缩放支持的所有质量模式的枚举。

为了在多个实现 FSR1 的应用程序中提供一致的用户体验。强烈建议在您的应用程序的用户界面中提供以下预设缩放因子。

如果您的应用程序不提供缩放算法的预设缩放因子概念（例如，而是实现一个固定的、不可变的比例），或者实现更动态的缩放方案（如动态分辨率缩放），则无需使用这些预设。

值

FFX_FSR1_QUALITY_MODE_ULTRA_QUALITY

FFX_FSR1_QUALITY_MODE_ULTRA_QUALITY = 0

以 1.3 倍的每维缩放比例执行缩放。

FFX_FSR1_QUALITY_MODE_QUALITY

FFX_FSR1_QUALITY_MODE_QUALITY = 1

以 1.5 倍的每维缩放比例执行缩放。

FFX_FSR1_QUALITY_MODE_BALANCED

FFX_FSR1_QUALITY_MODE_BALANCED = 2

以 1.7 倍的每维缩放比例执行缩放。

FFX_FSR1_QUALITY_MODE_PERFORMANCE

FFX_FSR1_QUALITY_MODE_PERFORMANCE = 3

以 2.0 倍的每维缩放比例执行缩放。

来源： sdk/include/FidelityFX/host/ffx_fsr1.h (第 99 行, 第 1 列)

FfxFsr1InitializationFlagBits

enum FfxFsr1InitializationFlagBits

创建 `FfxFsr1Context` 时使用的位标志枚举。请参阅 `FfxFsr1ContextDescription`。

值

FFX_FSR1_ENABLE_RCAS

FFX_FSR1_ENABLE_RCAS = (1 <<0)

一个位，指示是否应使用 rcas。

FFX_FSR1_RCAS_PASSTHROUGH_ALPHA

FFX_FSR1_RCAS_PASSTHROUGH_ALPHA = (1 <<1)

一个位，指示在 rcas 期间是否应使用直通 alpha。

FFX_FSR1_RCAS_DENOISE

FFX_FSR1_RCAS_DENOISE = (1 <<2)

一个位，指示在 rcas 期间是否调用去噪。

FFX_FSR1_ENABLE_HIGH_DYNAMIC_RANGE

FFX_FSR1_ENABLE_HIGH_DYNAMIC_RANGE = (1 <<3)

一个位，指示提供的输入颜色数据是否使用高动态范围。

FFX_FSR1_ENABLE_SRGB_CONVERSIONS

FFX_FSR1_ENABLE_SRGB_CONVERSIONS = (1 <<4)

一个位，指示输入/输出资源是否需要伽马转换。

FFX_FSR1_ENABLE_RCAS_LOWER_LIMITER_COMPENSATION

FFX_FSR1_ENABLE_RCAS_LOWER_LIMITER_COMPENSATION = (1 <<5)

一个位，指示是否应补偿 rcas 期间可能的负输出值。

来源： sdk/include/FidelityFX/host/ffx_fsr1.h (第 111 行, 第 1 列)

依赖项

此模块依赖于