FidelityFX LPM
FidelityFX LPM
FidelityFX 亮度保持映射器运行时库。
Defines
FFX_LPM_VERSION_MAJOR
#define FFX_LPM_VERSION_MAJOR (1)FidelityFX 亮度保持映射器 1.3 主版本。
来源: sdk/include/FidelityFX/host/ffx_lpm.h (line 38, column 9)
FFX_LPM_VERSION_MINOR
#define FFX_LPM_VERSION_MINOR (4)FidelityFX 亮度保持映射器 1.3 次版本。
来源: sdk/include/FidelityFX/host/ffx_lpm.h (line 43, column 9)
FFX_LPM_VERSION_PATCH
#define FFX_LPM_VERSION_PATCH (0)FidelityFX 亮度保持映射器 1.3 修订版本。
来源: sdk/include/FidelityFX/host/ffx_lpm.h (line 48, column 9)
FFX_LPM_CONTEXT_COUNT
#define FFX_LPM_CONTEXT_COUNT 1FidelityFX 亮度保持映射器上下文计数。
定义 LPM 所需的内部效果上下文数量
来源: sdk/include/FidelityFX/host/ffx_lpm.h (line 55, column 9)
FFX_LPM_CONTEXT_SIZE
#define FFX_LPM_CONTEXT_SIZE (9300)以 32 位值为单位指定的上下文大小。
来源: sdk/include/FidelityFX/host/ffx_lpm.h (line 60, column 9)
函数
ffxLpmContextCreate
FFX_API FfxErrorCode ffxLpmContextCreate(FfxLpmContext *pContext, const FfxLpmContextDescription *pContextDescription)根据 FfxLpmContextDescription 结构体中编程的参数,创建 FidelityFX Luma Preserving 1.0 上下文。
上下文结构体是与 Luma Preserving Mapper 1.0 API 交互的主要对象,负责管理 LPM 算法使用的内部资源。调用此 API 时,将通过回调结构体中的指针进行多次调用。这些回调将尝试检索设备功能,并创建 LPM 帧到帧功能所需的内部资源和管道。根据创建 FfxLpmContext 时使用的精确配置,可能会通过回调函数请求一组不同的资源和管道。
FfxLpmContext 应在使用完成后销毁,通常是在应用程序卸载或用户禁用 LPM 色调和色域映射时。要销毁 LPM 上下文,应调用 ffxLpmContextDestroy。
参数
pContext(FfxLpmContext *) – [输出] 指向要填充的 FfxLpmContext 结构的指针。pContextDescription(const FfxLpmContextDescription *) – [输入] 指向 FfxLpmContextDescription 结构的指针。
返回: FFX_API FfxErrorCode
来源: sdk/include/FidelityFX/host/ffx_lpm.h (line 207, column 22)
ffxLpmContextDispatch
FFX_API FfxErrorCode ffxLpmContextDispatch(FfxLpmContext *pContext, const FfxLpmDispatchDescription *pDispatchDescription)将工作调度到 FidelityFX LPM 上下文中。
参数
pContext(FfxLpmContext *) – [输出] 指向要填充的 FfxLpmContext 结构的指针。pDispatchDescription(const FfxLpmDispatchDescription *) – [输入] 指向 FfxLpmDispatchDescription 结构的指针。
返回: FFX_API FfxErrorCode
来源: sdk/include/FidelityFX/host/ffx_lpm.h (line 221, column 22)
ffxLpmContextDestroy
FFX_API FfxErrorCode ffxLpmContextDestroy(FfxLpmContext *pContext)销毁 FidelityFX LPM 上下文。
参数
pContext(FfxLpmContext *) – [输出] 指向要销毁的 FfxLpmContext 结构的指针。
返回: FFX_API FfxErrorCode
来源: sdk/include/FidelityFX/host/ffx_lpm.h (line 233, column 22)
FfxPopulateLpmConsts
FFX_API FfxErrorCode FfxPopulateLpmConsts(bool incon, bool insoft, bool incon2, bool inclip, bool inscaleOnly, uint32_t &outcon, uint32_t &outsoft, uint32_t &outcon2, uint32_t &outclip, uint32_t &outscaleOnly)设置 LPM 计算所需的常量缓冲区数据。
参数
incon(bool) – [输入]insoft(bool) – [输入]incon2(bool) – [输入]inclip(bool) – [输入]inscaleOnly(bool) – [输入]outcon(uint32_t &) – [输出]outsoft(uint32_t &) – [输出]outcon2(uint32_t &) – [输出]outclip(uint32_t &) – [输出]outscaleOnly(uint32_t &) – [输出]
返回: FFX_API FfxErrorCode
来源: sdk/include/FidelityFX/host/ffx_lpm.h (line 252, column 22)
ffxLpmGetEffectVersion
FFX_API FfxVersionNumber ffxLpmGetEffectVersion()查询效果版本号。
返回: 构建该效果的 SDK 版本。
返回: FFX_API FfxVersionNumber
来源: sdk/include/FidelityFX/host/ffx_lpm.h (line 269, column 26)
枚举
FfxLpmPass
enum FfxLpmPass构成 LPM 算法的所有通道的枚举。
LPM 实现为多个计算通道的组合,每个通道计算最终结果的关键部分。每次调用 FfxLPMScheduleGpuJobFunc 回调函数将对应于 FfxLPMPass 中包含的一个通道。有关每个通道的更全面描述,请参阅 LPM 参考文档。
值
FFX_LPM_PASS_FILTER
FFX_LPM_PASS_FILTER = 0使用 LPM 的色调和色域映射解决方案过滤颜色缓冲区的通道。
FFX_LPM_PASS_COUNT
LPM 执行的通道数。
来源: sdk/include/FidelityFX/host/ffx_lpm.h (line 76, column 1)
FfxLpmInitializationFlagBits
enum FfxLpmInitializationFlagBits创建 FfxLpmContext 时使用的位标志枚举。请参阅 FfxLpmContextDescription。
来源: sdk/include/FidelityFX/host/ffx_lpm.h (line 118, column 1)
依赖项: FfxLpmContext, FfxLpmContextDescription, FfxLpmDispatchDescription