159 lines
7.0 KiB
C
159 lines
7.0 KiB
C
// This file is part of the FidelityFX SDK.
|
|
//
|
|
// Copyright (c) 2022 Advanced Micro Devices, Inc. All rights reserved.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
// @defgroup VK
|
|
|
|
#pragma once
|
|
|
|
#include <vulkan/vulkan.h>
|
|
#include "../ffx_fsr2_interface.h"
|
|
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif // #if defined(__cplusplus)
|
|
|
|
/// Query how much memory is required for the Vulkan backend's scratch buffer.
|
|
///
|
|
/// @returns
|
|
/// The size (in bytes) of the required scratch memory buffer for the VK backend.
|
|
FFX_API size_t ffxFsr2GetScratchMemorySizeVK(VkPhysicalDevice physicalDevice, uint32_t = 0);
|
|
FFX_API void ffxFsr2SetInstanceFunctions( VkInstance instance, PFN_vkGetInstanceProcAddr getInstanceProcAddr );
|
|
|
|
/// Populate an interface with pointers for the VK backend.
|
|
///
|
|
/// @param [out] fsr2Interface A pointer to a <c><i>FfxFsr2Interface</i></c> structure to populate with pointers.
|
|
/// @param [in] device A Vulkan device.
|
|
/// @param [in] scratchBuffer A pointer to a buffer of memory which can be used by the DirectX(R)12 backend.
|
|
/// @param [in] scratchBufferSize The size (in bytes) of the buffer pointed to by <c><i>scratchBuffer</i></c>.
|
|
/// @param [in] physicalDevice The Vulkan physical device that FSR 2.0 will be executed on.
|
|
/// @param [in] getDeviceProcAddr A function pointer to vkGetDeviceProcAddr which is used to obtain all the other Vulkan functions.
|
|
///
|
|
/// @retval
|
|
/// FFX_OK The operation completed successfully.
|
|
/// @retval
|
|
/// FFX_ERROR_CODE_INVALID_POINTER The <c><i>interface</i></c> pointer was <c><i>NULL</i></c>.
|
|
///
|
|
/// @ingroup FSR2 VK
|
|
FFX_API FfxErrorCode ffxFsr2GetInterfaceVK(
|
|
FfxFsr2Interface* outInterface,
|
|
void* scratchBuffer,
|
|
size_t scratchBufferSize,
|
|
VkPhysicalDevice physicalDevice,
|
|
PFN_vkGetDeviceProcAddr getDeviceProcAddr);
|
|
|
|
/// Create a <c><i>FfxFsr2Device</i></c> from a <c><i>VkDevice</i></c>.
|
|
///
|
|
/// @param [in] device A pointer to the Vulkan logical device.
|
|
///
|
|
/// @returns
|
|
/// An abstract FidelityFX device.
|
|
///
|
|
/// @ingroup FSR2 VK
|
|
FFX_API FfxDevice ffxGetDeviceVK(VkDevice device);
|
|
|
|
/// Create a <c><i>FfxCommandList</i></c> from a <c><i>VkCommandBuffer</i></c>.
|
|
///
|
|
/// @param [in] cmdBuf A pointer to the Vulkan command buffer.
|
|
///
|
|
/// @returns
|
|
/// An abstract FidelityFX command list.
|
|
///
|
|
/// @ingroup FSR2 VK
|
|
FFX_API FfxCommandList ffxGetCommandListVK(VkCommandBuffer cmdBuf);
|
|
|
|
/// Create a <c><i>FfxResource</i></c> from a <c><i>VkImage</i></c>.
|
|
///
|
|
/// @param [in] context A pointer to a <c><i>FfxFsr2Context</i></c> structure.
|
|
/// @param [in] imgVk A Vulkan image resource.
|
|
/// @param [in] imageView An image view of the given image resource.
|
|
/// @param [in] width The width of the image resource.
|
|
/// @param [in] height The height of the image resource.
|
|
/// @param [in] imgFormat The format of the image resource.
|
|
/// @param [in] name (optional) A name string to identify the resource in debug mode.
|
|
/// @param [in] state The state the resource is currently in.
|
|
///
|
|
/// @returns
|
|
/// An abstract FidelityFX resources.
|
|
///
|
|
/// @ingroup FSR2 VK
|
|
FFX_API FfxResource ffxGetTextureResourceVK(FfxFsr2Context* context,
|
|
VkImage imgVk,
|
|
VkImageView imageView,
|
|
uint32_t width,
|
|
uint32_t height,
|
|
VkFormat imgFormat,
|
|
wchar_t* name = nullptr,
|
|
FfxResourceStates state = FFX_RESOURCE_STATE_COMPUTE_READ);
|
|
|
|
/// Create a <c><i>FfxResource</i></c> from a <c><i>VkBuffer</i></c>.
|
|
///
|
|
/// @param [in] context A pointer to a <c><i>FfxFsr2Context</i></c> structure.
|
|
/// @param [in] bufVk A Vulkan buffer resource.
|
|
/// @param [in] size The size of the buffer resource.
|
|
/// @param [in] name (optional) A name string to identify the resource in debug mode.
|
|
/// @param [in] state The state the resource is currently in.
|
|
///
|
|
/// @returns
|
|
/// An abstract FidelityFX resources.
|
|
///
|
|
/// @ingroup FSR2 VK
|
|
FFX_API FfxResource ffxGetBufferResourceVK(FfxFsr2Context* context,
|
|
VkBuffer bufVk,
|
|
uint32_t size,
|
|
wchar_t* name = nullptr,
|
|
FfxResourceStates state = FFX_RESOURCE_STATE_COMPUTE_READ);
|
|
|
|
/// Convert a <c><i>FfxResource</i></c> value to a <c><i>VkImage</i></c>.
|
|
///
|
|
/// @param [in] context A pointer to a <c><i>FfxFsr2Context</i></c> structure.
|
|
/// @param [in] resId A resourceID.
|
|
///
|
|
/// @returns
|
|
/// A <c><i>VkImage</i></c>.
|
|
///
|
|
/// @ingroup FSR2 VK
|
|
FFX_API VkImage ffxGetVkImage(FfxFsr2Context* context, uint32_t resId);
|
|
|
|
/// Convert a <c><i>FfxResource</i></c> value to a <c><i>VkImageView</i></c>.
|
|
///
|
|
/// @param [in] context A pointer to a <c><i>FfxFsr2Context</i></c> structure.
|
|
/// @param [in] resId A resourceID.
|
|
///
|
|
/// @returns
|
|
/// A <c><i>VkImage</i></c>.
|
|
///
|
|
/// @ingroup FSR2 VK
|
|
FFX_API VkImageView ffxGetVkImageView(FfxFsr2Context* context, uint32_t resId);
|
|
|
|
/// Convert a <c><i>FfxResource</i></c> value to a <c><i>VkImageLayout</i></c>.
|
|
///
|
|
/// @param [in] context A pointer to a <c><i>FfxFsr2Context</i></c> structure.
|
|
/// @param [in] resId A resourceID.
|
|
///
|
|
/// @returns
|
|
/// A <c><i>VkImage</i></c>.
|
|
///
|
|
/// @ingroup FSR2 VK
|
|
FFX_API VkImageLayout ffxGetVkImageLayout(FfxFsr2Context* context, uint32_t resId);
|
|
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif // #if defined(__cplusplus)
|