FidelityFX CAS

FidelityFX Contrast Adaptive Sharpening GPU documentation.

Functions

Return type	Description
FfxUInt32	ffxCasSupportScaling ( FFX_PARAMETER_IN FfxFloat32 outX, FFX_PARAMETER_IN FfxFloat32 outY, FFX_PARAMETER_IN FfxFloat32 inX, FFX_PARAMETER_IN FfxFloat32 inY ) A function to check if the scaling ratio is supported by CAS.
FFX_STATIC void	ffxCasSetup ( FFX_PARAMETER_INOUT FfxUInt32x4 const0, FFX_PARAMETER_INOUT FfxUInt32x4 const1, FFX_PARAMETER_IN FfxFloat32 sharpness, FFX_PARAMETER_IN FfxFloat32 inputSizeInPixelsX, FFX_PARAMETER_IN FfxFloat32 inputSizeInPixelsY, FFX_PARAMETER_IN FfxFloat32 outputSizeInPixelsX, FFX_PARAMETER_IN FfxFloat32 outputSizeInPixelsY ) Call to setup required constant values (works on CPU or GPU).

Macros

Name	Description
FFX_CAS_AREA_LIMIT (4.0)	The maximum scaling ratio that CAS can support.

Detailed description

FidelityFX Contrast Adaptive Sharpening GPU documentation.

Global functions

ffxCasSupportScaling

Copied!

FfxUInt32  ffxCasSupportScaling (
    FFX_PARAMETER_IN FfxFloat32  outX,
    FFX_PARAMETER_IN FfxFloat32  outY,
    FFX_PARAMETER_IN FfxFloat32  inX,
    FFX_PARAMETER_IN FfxFloat32  inY
)

A function to check if the scaling ratio is supported by CAS.

Contrast Adaptive Sharpening (CAS) supports a maximum scaling ratio expressed in FFX_CAS_AREA_LIMIT.

Parameters:

outX	The width of the target output, expressed in pixels.
outY	The height of the target output, expressed in pixels.
inX	The width of the input surface, expressed in pixels.
inY	The height of the input surface, expressed in pixels.

Returns:

True if CAS supports scaling in the given configuration.

ffxCasSetup

Copied!

FFX_STATIC  void ffxCasSetup (
    FFX_PARAMETER_INOUT FfxUInt32x4  const0,
    FFX_PARAMETER_INOUT FfxUInt32x4  const1,
    FFX_PARAMETER_IN FfxFloat32  sharpness,
    FFX_PARAMETER_IN FfxFloat32  inputSizeInPixelsX,
    FFX_PARAMETER_IN FfxFloat32  inputSizeInPixelsY,
    FFX_PARAMETER_IN FfxFloat32  outputSizeInPixelsX,
    FFX_PARAMETER_IN FfxFloat32  outputSizeInPixelsY
)

Call to setup required constant values (works on CPU or GPU).

Parameters:

const0	The first 4 32-bit values of the constant buffer which is populated by this function.
const1	The second 4 32-bit values of the constant buffer which is populated by this function.
sharpness	Set to 0 for the default (lower ringing), 1 for maximum (higest ringing).
inputSizeInPixelsX	The size of the input resolution in the X dimension.
inputSizeInPixelsY	The size of the input resolution in the Y dimension.
outputSizeInPixelsX	The size of the output resolution in the X dimension.
outputSizeInPixelsY	The size of the output resolution in the Y dimension.