Crate fsr_sys

Source

Structs§

ClearFloatJobDescription
A structure describing a clear render job.
CommandList
A typedef representing a command list or command buffer.
ComputeJobDescription
A structure describing a compute render job.
ConstantBuffer
A structure containing a constant buffer.
Context
A structure encapsulating the FidelityFX Super Resolution 2 context.
ContextDescription
A structure encapsulating the parameters required to initialize FidelityFX Super Resolution 2 upscaling.
CopyJobDescription
A structure describing a copy render job.
CreateResourceDescription
A structure containing the data required to create a resource.
DeviceCapabilities
A structure encapasulating a collection of device capabilities.
Dimensions2D
A structure encapsulating a 2-dimensional point, using 32bit unsigned integers.
DispatchDescription
A structure encapsulating the parameters for dispatching the various passes of FidelityFX Super Resolution 2.
FloatCoords2D
A structure encapsulating a 2-dimensional set of floating point coordinates.
GenerateReactiveDescription
A structure encapsulating the parameters for automatic generation of a reactive mask
GpuJobDescription
A structure describing a single render job.
IntCoords2D
A structure encapsulating a 2-dimensional point,
Interface
A structure encapsulating the interface between the core implentation of the FSR2 algorithm and any graphics API that it should ultimately call.
PipelineDescription
A structure containing the description used to create a FfxPipeline structure.
PipelineState
A structure encapsulating a single pass of an algorithm.
Resource
An outward facing structure containing a resource
ResourceBinding
A structure defining a resource bind point
ResourceDescription
A structure describing a resource.
ResourceInternal
An internal structure containing a handle to a resource and resource views

Enums§

MsgType
ResourceStates
An enumeration of resource states.

Constants§

FFX_EOF
< The end of the file was encountered.
FFX_EPSILON
An epsilon value for floating point numbers.
FFX_ERROR_BACKEND_API_ERROR
< The operation failed because the backend API returned an error code.
FFX_ERROR_EOF
< The operation failed because end of file was reached.
FFX_ERROR_INCOMPLETE_INTERFACE
< The operation failed because the interface was not fully configured.
FFX_ERROR_INSUFFICIENT_MEMORY
< The operation failed because there was not enough memory.
FFX_ERROR_INVALID_ALIGNMENT
< The operation failed due to an invalid alignment.
FFX_ERROR_INVALID_ARGUMENT
< The operation failed because an argument was invalid.
FFX_ERROR_INVALID_ENUM
< The operation failed because of an invalid enumeration value.
FFX_ERROR_INVALID_PATH
< The operation failed because the specified path was invalid.
FFX_ERROR_INVALID_POINTER
< The operation failed due to an invalid pointer.
FFX_ERROR_INVALID_SIZE
< The operation failed due to an invalid size.
FFX_ERROR_MALFORMED_DATA
< The operation failed because of some malformed data.
FFX_ERROR_NULL_DEVICE
< The operation failed because a device was null.
FFX_ERROR_OUT_OF_MEMORY
< The operation failed because it ran out memory.
FFX_ERROR_OUT_OF_RANGE
< The operation failed because a value was out of range.
FFX_FILTER_TYPE_LINEAR
< Sampling with interpolation.
FFX_FILTER_TYPE_POINT
< Point sampling.
FFX_FSR2_CONTEXT_SIZE
FFX_FSR2_ENABLE_AUTO_EXPOSURE
< A bit indicating if automatic exposure should be applied to input color data.
FFX_FSR2_ENABLE_DEBUG_CHECKING
< A bit indicating that the runtime should check some API values and report issues.
FFX_FSR2_ENABLE_DEPTH_INFINITE
< A bit indicating that the input depth buffer data provided is using an infinite far plane.
FFX_FSR2_ENABLE_DEPTH_INVERTED
< A bit indicating that the input depth buffer data provided is inverted [1..0].
FFX_FSR2_ENABLE_DISPLAY_RESOLUTION_MOTION_VECTORS
< A bit indicating if the motion vectors are rendered at display resolution.
FFX_FSR2_ENABLE_DYNAMIC_RESOLUTION
< A bit indicating that the application uses dynamic resolution scaling.
FFX_FSR2_ENABLE_HIGH_DYNAMIC_RANGE
< A bit indicating if the input color data provided is using a high-dynamic range.
FFX_FSR2_ENABLE_MOTION_VECTORS_JITTER_CANCELLATION
< A bit indicating that the motion vectors have the jittering pattern applied to them.
FFX_FSR2_ENABLE_TEXTURE1D_USAGE
< A bit indicating that the backend should use 1D textures.
FFX_FSR2_PASS_ACCUMULATE
< A pass which performs upscaling.
FFX_FSR2_PASS_ACCUMULATE_SHARPEN
< A pass which performs upscaling when sharpening is used.
FFX_FSR2_PASS_COMPUTE_LUMINANCE_PYRAMID
< A pass which generates the luminance mipmap chain for the current frame.
FFX_FSR2_PASS_COUNT
< The number of passes performed by FSR2.
FFX_FSR2_PASS_DEPTH_CLIP
< A pass which performs depth clipping.
FFX_FSR2_PASS_GENERATE_REACTIVE
< An optional pass to generate a reactive mask
FFX_FSR2_PASS_LOCK
< A pass which calculates pixel locks.
FFX_FSR2_PASS_RCAS
< A pass which performs sharpening.
FFX_FSR2_PASS_RECONSTRUCT_PREVIOUS_DEPTH
< A pass which performs reconstruction of previous frame’s depth.
FFX_FSR2_PASS_TCR_AUTOGENERATE
< An optional pass to generate a texture-and-composition and reactive masks
FFX_FSR2_QUALITY_MODE_BALANCED
< Perform upscaling with a per-dimension upscaling ratio of 1.7x.
FFX_FSR2_QUALITY_MODE_PERFORMANCE
< Perform upscaling with a per-dimension upscaling ratio of 2.0x.
FFX_FSR2_QUALITY_MODE_QUALITY
< Perform upscaling with a per-dimension upscaling ratio of 1.5x.
FFX_FSR2_QUALITY_MODE_ULTRA_PERFORMANCE
< Perform upscaling with a per-dimension upscaling ratio of 3.0x.
FFX_FSR2_VERSION_MAJOR
FFX_FSR2_VERSION_MINOR
FFX_FSR2_VERSION_PATCH
FFX_GPU_JOB_CLEAR_FLOAT
< The GPU job is performing a floating-point clear.
FFX_GPU_JOB_COMPUTE
< The GPU job is performing a compute dispatch.
FFX_GPU_JOB_COPY
< The GPU job is performing a copy.
FFX_HEAP_TYPE_DEFAULT
< Local memory.
FFX_HEAP_TYPE_UPLOAD
< Heap used for uploading resources.
FFX_MAXIMUM_PATH
FFX_MAX_CONST_SIZE
FFX_MAX_NUM_CONST_BUFFERS
FFX_MAX_NUM_SRVS
FFX_MAX_NUM_UAVS
FFX_OK
< The operation completed successfully.
FFX_PI
The value of Pi.
FFX_RESOURCE_DIMENSION_TEXTURE_1D
< A resource with a single dimension.
FFX_RESOURCE_DIMENSION_TEXTURE_2D
< A resource with two dimensions.
FFX_RESOURCE_FLAGS_ALIASABLE
< A bit indicating a resource does not need to persist across frames.
FFX_RESOURCE_FLAGS_NONE
< No flags.
FFX_RESOURCE_TYPE_BUFFER
< The resource is a buffer.
FFX_RESOURCE_TYPE_TEXTURE1D
< The resource is a 1-dimensional texture.
FFX_RESOURCE_TYPE_TEXTURE2D
< The resource is a 2-dimensional texture.
FFX_RESOURCE_TYPE_TEXTURE3D
< The resource is a 3-dimensional texture.
FFX_RESOURCE_USAGE_READ_ONLY
< No usage flags indicate a resource is read only.
FFX_RESOURCE_USAGE_RENDERTARGET
< Indicates a resource will be used as render target.
FFX_RESOURCE_USAGE_UAV
< Indicates a resource will be used as UAV.
FFX_RESOURCE_VIEW_SHADER_READ
< The resource view is a shader resource view (SRV).
FFX_RESOURCE_VIEW_UNORDERED_ACCESS
< The resource view is an unordered access view (UAV).
FFX_SHADER_MODEL_5_1
< Shader model 5.1.
FFX_SHADER_MODEL_6_0
< Shader model 6.0.
FFX_SHADER_MODEL_6_1
< Shader model 6.1.
FFX_SHADER_MODEL_6_2
< Shader model 6.2.
FFX_SHADER_MODEL_6_3
< Shader model 6.3.
FFX_SHADER_MODEL_6_4
< Shader model 6.4.
FFX_SHADER_MODEL_6_5
< Shader model 6.5.
FFX_SHADER_MODEL_6_6
< Shader model 6.6.
FFX_SHADER_MODEL_6_7
< Shader model 6.7.
FFX_SURFACE_FORMAT_R8G8B8A8_TYPELESS
< 8 bit per channel, 4 channel float format
FFX_SURFACE_FORMAT_R8G8B8A8_UNORM
< 8 bit per channel, 4 channel unsigned normalized format
FFX_SURFACE_FORMAT_R8G8_UNORM
< 8 bit per channel, 2 channel unsigned normalized format
FFX_SURFACE_FORMAT_R8_UINT
< 8 bit per channel, 1 channel unsigned int format
FFX_SURFACE_FORMAT_R8_UNORM
< 8 bit per channel, 1 channel unsigned normalized format
FFX_SURFACE_FORMAT_R11G11B10_FLOAT
< 32 bit 3 channel float format
FFX_SURFACE_FORMAT_R16G16B16A16_FLOAT
< 16 bit per channel, 4 channel float format
FFX_SURFACE_FORMAT_R16G16B16A16_UNORM
< 16 bit per channel, 4 channel unsigned normalized format
FFX_SURFACE_FORMAT_R16G16_FLOAT
< 16 bit per channel, 2 channel float format
FFX_SURFACE_FORMAT_R16G16_UINT
< 16 bit per channel, 2 channel unsigned int format
FFX_SURFACE_FORMAT_R16_FLOAT
< 16 bit per channel, 1 channel float format
FFX_SURFACE_FORMAT_R16_SNORM
< 16 bit per channel, 1 channel signed normalized format
FFX_SURFACE_FORMAT_R16_UINT
< 16 bit per channel, 1 channel unsigned int format
FFX_SURFACE_FORMAT_R16_UNORM
< 16 bit per channel, 1 channel unsigned normalized format
FFX_SURFACE_FORMAT_R32G32B32A32_FLOAT
< 32 bit per channel, 4 channel float format
FFX_SURFACE_FORMAT_R32G32B32A32_TYPELESS
< 32 bit per channel, 4 channel typeless format
FFX_SURFACE_FORMAT_R32G32_FLOAT
< 32 bit per channel, 2 channel float format
FFX_SURFACE_FORMAT_R32_FLOAT
< 32 bit per channel, 1 channel float format
FFX_SURFACE_FORMAT_R32_UINT
< 32 bit per channel, 1 channel float format
FFX_SURFACE_FORMAT_UNKNOWN
< Unknown format
FFX_UNSPECIFIED_VERSION

Functions§

AssertReport⚠
Function to report an assert.
AssertSetPrintingCallback⚠
Provides the ability to set a callback for assert messages.
ContextCreate⚠
Create a FidelityFX Super Resolution 2 context from the parameters programmed to the FfxFsr2CreateParams structure.
ContextDestroy⚠
Destroy the FidelityFX Super Resolution context.
ContextDispatch⚠
Dispatch the various passes that constitute FidelityFX Super Resolution 2.
ContextGenerateReactiveMask⚠
A helper function generate a Reactive mask from an opaque only texure and one containing translucent objects.
GetJitterOffset⚠
A helper function to calculate the subpixel jitter offset.
GetJitterPhaseCount⚠
A helper function to calculate the jitter phase count from display resolution.
GetRenderResolutionFromQualityMode⚠
A helper function to calculate the rendering resolution from a target resolution and desired quality level.
GetUpscaleRatioFromQualityMode⚠
Get the upscale ratio from the quality mode.
ResourceIsNull⚠
A helper function to check if a resource is FFX_FSR2_RESOURCE_IDENTIFIER_NULL.

Type Aliases§

AssertCallback
A typedef for the callback function for assert printing.
CreateBackendContextFunc
Create and initialize the backend context.
CreatePipelineFunc
Create a render pipeline.
CreateResourceFunc
Create a resource.
DestroyBackendContextFunc
Destroy the backend context and dereference the device.
DestroyPipelineFunc
Destroy a render pipeline.
DestroyResourceFunc
Destroy a resource
Device
A typedef representing the graphics device.
ErrorCode
Typedef for error codes returned from functions in the FidelityFX SDK.
ExecuteGpuJobsFunc
Execute scheduled render jobs on the comandList provided.
FilterType
The type of filtering to perform when reading a texture.
GetDeviceCapabilitiesFunc
Get a list of capabilities of the device.
GetResourceDescriptionFunc
Retrieve a FfxResourceDescription matching a FfxResource structure.
GpuJobType
An enumberation for different render job types
HeapType
An enumeration for different heap types
InitializationFlagBits
An enumeration of bit flags used when creating a FfxFsr2Context. See FfxFsr2ContextDescription.
Message
Pass a string message
Pass
An enumeration of all the passes which constitute the FSR2 algorithm.
Pipeline
A typedef for a pipeline state object.
QualityMode
An enumeration of all the quality modes supported by FidelityFX Super Resolution 2 upscaling.
RegisterResourceFunc
Register a resource in the backend for the current frame.
ResourceDimension
An enumeration of surface dimensions.
ResourceFlags
An enumeration of surface dimensions.
ResourceType
ResourceUsage
An enumeration of resource usage.
ResourceViewType
An enumeration of all resource view types.
RootSignature
A typedef for a root signature.
ScheduleGpuJobFunc
Schedule a render job to be executed on the next call of FfxFsr2ExecuteGpuJobsFunc.
ShaderModel
An enumeration of all supported shader models.
SurfaceFormat
An enumeration of surface formats.
UnregisterResourcesFunc
Unregister all temporary FfxResourceInternal from the backend.

Unions§

GpuJobDescription__bindgen_ty_1