Added ISuperResolutionUpscaler interface and SuperResolution device feature

Author: MikhailGorobets

Graphics/Archiver/include/SerializationDeviceImpl.hpp

@@ -70,11 +70,14 @@ class SerializationDeviceImpl final : public RenderDeviceBase<SerializationEngin
     UNSUPPORTED_METHOD(void, CreateTLAS,        const TopLevelASDesc&         Desc, ITopLevelAS**         ppTLAS)
     UNSUPPORTED_METHOD(void, CreateSBT,         const ShaderBindingTableDesc& Desc, IShaderBindingTable** ppSBT)
     UNSUPPORTED_METHOD(void, CreatePipelineResourceSignature, const PipelineResourceSignatureDesc& Desc, IPipelineResourceSignature** ppSignature)
+    UNSUPPORTED_METHOD(void, CreateSuperResolution,           const SuperResolutionDesc&           Desc, ISuperResolution**           ppUpscaler)
     UNSUPPORTED_METHOD(void, CreateDeviceMemory,       const DeviceMemoryCreateInfo&       CreateInfo, IDeviceMemory**       ppMemory)
     UNSUPPORTED_METHOD(void, CreatePipelineStateCache, const PipelineStateCacheCreateInfo& CreateInfo, IPipelineStateCache** ppPSOCache)
     UNSUPPORTED_METHOD(void, CreateDeferredContext, IDeviceContext** ppContext)
     UNSUPPORTED_METHOD(void, IdleGPU)
     UNSUPPORTED_METHOD(void, ReleaseStaleResources, bool ForceRelease)
+
+    UNSUPPORTED_CONST_METHOD(void, GetSuperResSourceSettings, const GetSuperResSourceSettingsAttribs& Attribs, SuperResolutionSourceSettings& Settings)
     // clang-format on
 
     /// Implementation of IRenderDevice::CreateRenderPass().

Graphics/Archiver/include/SerializationEngineImplTraits.hpp

@@ -91,6 +91,7 @@ struct SerializationEngineImplTraits
     using PipelineResourceSignatureImplType = SerializedResourceSignatureImpl;
     using DeviceMemoryImplType              = SerializedObjectStub;
     using PipelineStateCacheImplType        = SerializedObjectStub;
+    using SuperResolutionImplType           = SerializedObjectStub;
 };
 
 template <typename ReturnType>

Graphics/GraphicsEngine.NET/Mapping.xml

@@ -55,6 +55,7 @@
 	<include file="ShaderBindingTable.h" namespace="Diligent" attach="true"/>
 	<include file="ShaderResourceBinding.h" namespace="Diligent" attach="true"/>
 	<include file="ShaderResourceVariable.h" namespace="Diligent" attach="true"/>
+	<include file="SuperResolution.h" namespace="Diligent" attach="true"/>
 	<include file="SwapChain.h" namespace="Diligent" attach="true"/>
 	<include file="Texture.h" namespace="Diligent" attach="true"/>
 	<include file="TextureView.h" namespace="Diligent" attach="true"/>
@@ -248,6 +249,7 @@
 		<map param="IRenderDevice::CreateBuffer::pBuffData" attribute="optional" default="null"/>
 		<map param="IRenderDevice::CreateTexture::pData" attribute="optional" default="null"/>
 		<map param="IRenderDevice::Create(.+)PipelineState::PSOCreateInfo" name="createInfo"/>
+		<map param="IRenderDevice::GetSuperResSourceSettings::Settings" attribute="out"/>
 
 		<!--Diligent::IDeviceContext-->
 		<map method="IDeviceContext::SetVertexBuffers" visibility="private"/>
@@ -299,6 +301,10 @@
 		<!--Diligent::IQuery-->
 		<map method="IQuery::GetData" visibility="private"/>
 		<map param="IQuery::GetData::pData" type="void" keep-pointers="true"/>
+
+		<!--Diligent::ISuperResolution-->
+		<map param="ISuperResolution::GetOptimalJitterPattern::pJitterX" attribute="out"/>
+		<map param="ISuperResolution::GetOptimalJitterPattern::pJitterY" attribute="out"/>
 	</mapping>
 
 </config>

Graphics/GraphicsEngine/include/RenderDeviceBase.hpp

@@ -52,6 +52,7 @@
 #include "IndexWrapper.hpp"
 #include "ThreadPool.hpp"
 #include "SpinLock.hpp"
+#include "SuperResolution.h"
 
 namespace Diligent
 {
@@ -119,6 +120,7 @@ class RenderDeviceBase : public ObjectBase<typename EngineImplTraits::RenderDevi
     using PipelineResourceSignatureImplType = typename EngineImplTraits::PipelineResourceSignatureImplType;
     using DeviceMemoryImplType              = typename EngineImplTraits::DeviceMemoryImplType;
     using PipelineStateCacheImplType        = typename EngineImplTraits::PipelineStateCacheImplType;
+    using SuperResolutionImplType           = typename EngineImplTraits::SuperResolutionImplType;
 
     /// \param pRefCounters    - Reference counters object that controls the lifetime of this render device
     /// \param RawMemAllocator - Allocator that will be used to allocate memory for all device objects (including render device itself)
@@ -638,6 +640,17 @@ class RenderDeviceBase : public ObjectBase<typename EngineImplTraits::RenderDevi
                            });
     }
 
+    template <typename... ExtraArgsType>
+    void CreateSuperResolutionImpl(ISuperResolution** ppUpscaler, const SuperResolutionDesc& Desc, const ExtraArgsType&... ExtraArgs)
+    {
+        CreateDeviceObject("Super Resolution Upscaler", Desc, ppUpscaler,
+                           [&]() //
+                           {
+                               SuperResolutionImplType* pUpscalerImpl = NEW_RC_OBJ(GetRawAllocator(), "SuperResolution instance", SuperResolutionImplType)(static_cast<RenderDeviceImplType*>(this), Desc, ExtraArgs...);
+                               pUpscalerImpl->QueryInterface(IID_SuperResolution, reinterpret_cast<IObject**>(ppUpscaler));
+                           });
+    }
+
     template <typename... ExtraArgsType>
     void CreateDeferredContextImpl(IDeviceContext** ppContext, const ExtraArgsType&... ExtraArgs)
     {

Graphics/GraphicsEngine/interface/Constants.h

@@ -65,15 +65,19 @@ DILIGENT_BEGIN_NAMESPACE(Diligent)
 /// The maximum number of 4-byte inline constants in a pipeline state.
 #define DILIGENT_MAX_INLINE_CONSTANTS 64
 
-static DILIGENT_CONSTEXPR Uint32 MAX_BUFFER_SLOTS        = DILIGENT_MAX_BUFFER_SLOTS;
-static DILIGENT_CONSTEXPR Uint32 MAX_RENDER_TARGETS      = DILIGENT_MAX_RENDER_TARGETS;
-static DILIGENT_CONSTEXPR Uint32 MAX_VIEWPORTS           = DILIGENT_MAX_VIEWPORTS;
-static DILIGENT_CONSTEXPR Uint32 MAX_RESOURCE_SIGNATURES = DILIGENT_MAX_RESOURCE_SIGNATURES;
-static DILIGENT_CONSTEXPR Uint32 MAX_ADAPTER_QUEUES      = DILIGENT_MAX_ADAPTER_QUEUES;
-static DILIGENT_CONSTEXPR Uint32 DEFAULT_ADAPTER_ID      = DILIGENT_DEFAULT_ADAPTER_ID;
-static DILIGENT_CONSTEXPR Uint8  DEFAULT_QUEUE_ID        = DILIGENT_DEFAULT_QUEUE_ID;
-static DILIGENT_CONSTEXPR Uint32 MAX_SHADING_RATES       = DILIGENT_MAX_SHADING_RATES;
-static DILIGENT_CONSTEXPR Uint32 SHADING_RATE_X_SHIFT    = DILIGENT_SHADING_RATE_X_SHIFT;
-static DILIGENT_CONSTEXPR Uint32 MAX_INLINE_CONSTANTS    = DILIGENT_MAX_INLINE_CONSTANTS;
+/// The maximum number of super resolution upscaler variants.
+#define DILIGENT_MAX_SUPER_RESOLUTION_UPSCALERS 8
+
+static DILIGENT_CONSTEXPR Uint32 MAX_BUFFER_SLOTS               = DILIGENT_MAX_BUFFER_SLOTS;
+static DILIGENT_CONSTEXPR Uint32 MAX_RENDER_TARGETS             = DILIGENT_MAX_RENDER_TARGETS;
+static DILIGENT_CONSTEXPR Uint32 MAX_VIEWPORTS                  = DILIGENT_MAX_VIEWPORTS;
+static DILIGENT_CONSTEXPR Uint32 MAX_RESOURCE_SIGNATURES        = DILIGENT_MAX_RESOURCE_SIGNATURES;
+static DILIGENT_CONSTEXPR Uint32 MAX_ADAPTER_QUEUES             = DILIGENT_MAX_ADAPTER_QUEUES;
+static DILIGENT_CONSTEXPR Uint32 DEFAULT_ADAPTER_ID             = DILIGENT_DEFAULT_ADAPTER_ID;
+static DILIGENT_CONSTEXPR Uint8  DEFAULT_QUEUE_ID               = DILIGENT_DEFAULT_QUEUE_ID;
+static DILIGENT_CONSTEXPR Uint32 MAX_SHADING_RATES              = DILIGENT_MAX_SHADING_RATES;
+static DILIGENT_CONSTEXPR Uint32 SHADING_RATE_X_SHIFT           = DILIGENT_SHADING_RATE_X_SHIFT;
+static DILIGENT_CONSTEXPR Uint32 MAX_INLINE_CONSTANTS           = DILIGENT_MAX_INLINE_CONSTANTS;
+static DILIGENT_CONSTEXPR Uint32 MAX_SUPER_RESOLUTION_UPSCALERS = DILIGENT_MAX_SUPER_RESOLUTION_UPSCALERS;
 
 DILIGENT_END_NAMESPACE // namespace Diligent

Graphics/GraphicsEngine/interface/DeviceContext.h

@@ -58,6 +58,7 @@
 #include "ShaderBindingTable.h"
 #include "DeviceMemory.h"
 #include "CommandQueue.h"
+#include "SuperResolution.h"
 
 DILIGENT_BEGIN_NAMESPACE(Diligent)
 
@@ -3750,6 +3751,26 @@ DILIGENT_BEGIN_INTERFACE(IDeviceContext, IObject)
 
     /// Returns the device context statistics, see Diligent::DeviceContextStats.
     VIRTUAL const DeviceContextStats REF METHOD(GetStats)(THIS) CONST PURE;
+
+
+    /// Executes the hardware super resolution upscaler.
+
+    /// \param [in] Attribs             - Upscale operation attributes, see Diligent::ExecuteSuperResolutionAttribs.
+    /// \param [in] pUpscaler           - Super resolution upscaler object to execute.
+    /// \param [in] TimeDeltaInSeconds  - Time elapsed since the previous frame, in seconds.
+    ///                                   Used by some upscalers to adjust temporal accumulation behavior.
+    /// \param [in] ResetHistory        - Set to true to reset temporal history (e.g., on camera cut).
+    ///
+    /// \remarks The command must be called outside of a render pass.
+    ///          All input textures must be in the appropriate states or
+    ///          TransitionMode should be set to RESOURCE_STATE_TRANSITION_MODE_TRANSITION.
+    ///
+    /// \remarks Supported contexts: graphics.
+    VIRTUAL void METHOD(ExecuteSuperResolution)(THIS_
+                                                const ExecuteSuperResolutionAttribs REF Attribs,
+                                                ISuperResolution*               pUpscaler,
+                                                float                                   TimeDeltaInSeconds DEFAULT_VALUE(0.0f),
+                                                Bool                                    ResetHistory       DEFAULT_VALUE(False)) PURE;
 };
 DILIGENT_END_INTERFACE
 
@@ -3829,6 +3850,7 @@ DILIGENT_END_INTERFACE
 #    define IDeviceContext_BindSparseResourceMemory(This, ...)      CALL_IFACE_METHOD(DeviceContext, BindSparseResourceMemory,  This, __VA_ARGS__)
 #    define IDeviceContext_ClearStats(This)                         CALL_IFACE_METHOD(DeviceContext, ClearStats,                This)
 #    define IDeviceContext_GetStats(This)                           CALL_IFACE_METHOD(DeviceContext, GetStats,                  This)
+#    define IDeviceContext_ExecuteSuperResolution(This, ...)        CALL_IFACE_METHOD(DeviceContext, ExecuteSuperResolution,    This, __VA_ARGS__)
 
 // clang-format on
 

Graphics/GraphicsEngine/interface/GraphicsTypes.h

@@ -1856,6 +1856,10 @@ struct DeviceFeatures
     /// Indicates if device supports formatted buffers.
     DEVICE_FEATURE_STATE FormattedBuffers       DEFAULT_INITIALIZER(DEVICE_FEATURE_STATE_DISABLED);
 
+    /// Indicates if the device supports hardware super resolution (upscaling).
+    /// MetalFX on Metal, DirectSR on D3D12.
+    DEVICE_FEATURE_STATE SuperResolution        DEFAULT_INITIALIZER(DEVICE_FEATURE_STATE_DISABLED);
+
 #if DILIGENT_CPP_INTERFACE
     constexpr DeviceFeatures() noexcept {}
 
@@ -1906,11 +1910,12 @@ struct DeviceFeatures
 	Handler(TextureSubresourceViews)		   \
 	Handler(NativeMultiDraw)                   \
     Handler(AsyncShaderCompilation)			   \
-	Handler(FormattedBuffers)
+	Handler(FormattedBuffers)                  \
+    Handler(SuperResolution)
 
     explicit constexpr DeviceFeatures(DEVICE_FEATURE_STATE State) noexcept
     {
-        static_assert(sizeof(*this) == 47, "Did you add a new feature to DeviceFeatures? Please add it to ENUMERATE_DEVICE_FEATURES.");
+        static_assert(sizeof(*this) == 48, "Did you add a new feature to DeviceFeatures? Please add it to ENUMERATE_DEVICE_FEATURES.");
     #define INIT_FEATURE(Feature) Feature = State;
         ENUMERATE_DEVICE_FEATURES(INIT_FEATURE)
     #undef INIT_FEATURE
@@ -3251,6 +3256,165 @@ struct SparseResourceProperties
 typedef struct SparseResourceProperties SparseResourceProperties;
 
 
+/// Super resolution upscaler type.
+DILIGENT_TYPED_ENUM(SUPER_RESOLUTION_UPSCALER_TYPE, Uint8)
+{
+    /// Spatial upscaling only (single frame, no motion vectors required).
+    SUPER_RESOLUTION_UPSCALER_TYPE_SPATIAL = 0u,
+
+    /// Temporal upscaling (uses motion vectors and history accumulation).
+    SUPER_RESOLUTION_UPSCALER_TYPE_TEMPORAL
+};
+
+
+/// Super resolution optimization type.
+/// Defines the quality/performance trade-off for super resolution upscaling.
+DILIGENT_TYPED_ENUM(SUPER_RESOLUTION_OPTIMIZATION_TYPE, Uint8)
+{
+    /// Maximum quality, lowest performance.
+    SUPER_RESOLUTION_OPTIMIZATION_TYPE_MAX_QUALITY = 0u,
+
+    /// Favor quality over performance.
+    SUPER_RESOLUTION_OPTIMIZATION_TYPE_HIGH_QUALITY,
+
+    /// Balanced quality/performance trade-off.
+    SUPER_RESOLUTION_OPTIMIZATION_TYPE_BALANCED,
+
+    /// Favor performance over quality.
+    SUPER_RESOLUTION_OPTIMIZATION_TYPE_HIGH_PERFORMANCE,
+
+    /// Maximum performance, lowest quality.
+    SUPER_RESOLUTION_OPTIMIZATION_TYPE_MAX_PERFORMANCE,
+
+    SUPER_RESOLUTION_OPTIMIZATION_TYPE_COUNT
+};
+
+
+/// Capability flags for spatial super resolution upscaling.
+DILIGENT_TYPED_ENUM(SUPER_RESOLUTION_SPATIAL_CAP_FLAGS, Uint32)
+{
+    SUPER_RESOLUTION_SPATIAL_CAP_FLAG_NONE   = 0u,
+
+    /// The upscaler is a native hardware-accelerated implementation (e.g. MetalFX, DirectSR)
+    /// as opposed to a custom software fallback.
+    SUPER_RESOLUTION_SPATIAL_CAP_FLAG_NATIVE = 1u << 0,
+
+    SUPER_RESOLUTION_SPATIAL_CAP_FLAG_LAST   = SUPER_RESOLUTION_SPATIAL_CAP_FLAG_NATIVE
+};
+DEFINE_FLAG_ENUM_OPERATORS(SUPER_RESOLUTION_SPATIAL_CAP_FLAGS)
+
+
+/// Capability flags for temporal super resolution upscaling.
+DILIGENT_TYPED_ENUM(SUPER_RESOLUTION_TEMPORAL_CAP_FLAGS, Uint32)
+{
+    SUPER_RESOLUTION_TEMPORAL_CAP_FLAG_NONE                    = 0u,
+
+    /// The upscaler is a native hardware-accelerated implementation (e.g. MetalFX, DirectSR)
+    /// as opposed to a custom software fallback.
+    SUPER_RESOLUTION_TEMPORAL_CAP_FLAG_NATIVE                  = 1u << 0,
+
+    /// The upscaler supports exposure scale texture input.
+    SUPER_RESOLUTION_TEMPORAL_CAP_FLAG_EXPOSURE_SCALE_TEXTURE  = 1u << 1,
+
+    /// The upscaler supports ignore history mask texture input.
+    /// When set, the backend processes the pIgnoreHistoryMaskTextureSRV field
+    /// in ExecuteSuperResolutionAttribs.
+    SUPER_RESOLUTION_TEMPORAL_CAP_FLAG_IGNORE_HISTORY_MASK     = 1u << 2,
+
+    /// The upscaler supports reactive mask texture input.
+    /// When set, the backend processes the pReactiveMaskTextureSRV field
+    /// in ExecuteSuperResolutionAttribs.
+    SUPER_RESOLUTION_TEMPORAL_CAP_FLAG_REACTIVE_MASK           = 1u << 3,
+
+    /// The upscaler supports the sharpness control parameter.
+    /// When set, the Sharpness field in ExecuteSuperResolutionAttribs is used.
+    SUPER_RESOLUTION_TEMPORAL_CAP_FLAG_SHARPNESS               = 1u << 4,
+
+    SUPER_RESOLUTION_TEMPORAL_CAP_FLAG_LAST                    = SUPER_RESOLUTION_TEMPORAL_CAP_FLAG_SHARPNESS
+};
+DEFINE_FLAG_ENUM_OPERATORS(SUPER_RESOLUTION_TEMPORAL_CAP_FLAGS)
+
+
+/// Information about a supported super resolution upscaler variant
+struct SuperResolutionInfo
+{
+    /// Human-readable name of the upscaler variant (e.g. "MetalFX Spatial", "MetalFX Temporal").
+    Char Name[128] DEFAULT_INITIALIZER({});
+
+    /// Unique identifier for this upscaler variant.
+    /// Pass this VariantId to SuperResolutionDesc when creating an upscaler.
+    INTERFACE_ID VariantId DEFAULT_INITIALIZER({});
+
+    /// Upscaler type. Determines which input textures and parameters are required.
+    SUPER_RESOLUTION_UPSCALER_TYPE Type DEFAULT_INITIALIZER(SUPER_RESOLUTION_UPSCALER_TYPE_SPATIAL);
+
+#if defined(DILIGENT_SHARP_GEN)
+    Uint32  CapFlags  DEFAULT_INITIALIZER(0);
+#else
+    union
+    {
+        /// Capability flags for SUPER_RESOLUTION_UPSCALER_TYPE_SPATIAL.
+        SUPER_RESOLUTION_SPATIAL_CAP_FLAGS  SpatialCapFlags DEFAULT_INITIALIZER(SUPER_RESOLUTION_SPATIAL_CAP_FLAG_NONE);
+
+        /// Capability flags for SUPER_RESOLUTION_UPSCALER_TYPE_TEMPORAL.
+        SUPER_RESOLUTION_TEMPORAL_CAP_FLAGS TemporalCapFlags;
+    };
+#endif
+
+#if DILIGENT_CPP_INTERFACE
+    constexpr Uint32 SpatialOrTemporalCapFlags() const
+    {
+        #if defined(DILIGENT_SHARP_GEN)
+            return CapFlags;
+        #else
+            return SpatialCapFlags;
+        #endif
+    }
+
+    /// Comparison operator tests if two structures are equivalent
+
+    /// \param [in] RHS - reference to the structure to perform comparison with
+    /// \return
+    /// - True if all members of the two structures are equal.
+    /// - False otherwise.
+    bool operator==(const SuperResolutionInfo& RHS) const noexcept
+    {
+        return VariantId                   == RHS.VariantId                   &&
+               Type                        == RHS.Type                        &&
+               SpatialOrTemporalCapFlags() == RHS.SpatialOrTemporalCapFlags() &&
+               memcmp(Name, RHS.Name, sizeof(Name)) == 0;
+    }
+#endif
+};
+typedef struct SuperResolutionInfo SuperResolutionInfo;
+
+
+/// Super resolution properties, reported via GraphicsAdapterInfo
+struct SuperResolutionProperties
+{
+    /// Array of supported upscaler variants and their capabilities.
+    SuperResolutionInfo Upscalers[DILIGENT_MAX_SUPER_RESOLUTION_UPSCALERS] DEFAULT_INITIALIZER({});
+
+    /// The number of valid elements in the Upscalers array.
+    Uint8 NumUpscalers DEFAULT_INITIALIZER(0);
+
+#if DILIGENT_CPP_INTERFACE
+    bool operator==(const SuperResolutionProperties& RHS) const
+    {
+        if (NumUpscalers != RHS.NumUpscalers)
+            return false;
+
+        for (Uint8 i = 0; i < NumUpscalers; ++i)
+            if (!(Upscalers[i] == RHS.Upscalers[i]))
+                return false;
+
+        return true;
+    }
+#endif
+};
+typedef struct SuperResolutionProperties SuperResolutionProperties;
+
+
 /// Command queue properties
 struct CommandQueueInfo
 {
@@ -3342,6 +3506,9 @@ struct GraphicsAdapterInfo
     /// Sparse resource properties, see Diligent::SparseResourceProperties.
     SparseResourceProperties SparseResources;
 
+    /// Super resolution upscaler properties, see Diligent::SuperResolutionProperties.
+    SuperResolutionProperties SuperResolution;
+
     /// Supported device features, see Diligent::DeviceFeatures.
 
     /// The feature state indicates:
@@ -3388,6 +3555,7 @@ struct GraphicsAdapterInfo
                ComputeShader   == RHS.ComputeShader   &&
                DrawCommand     == RHS.DrawCommand     &&
                SparseResources == RHS.SparseResources &&
+               SuperResolution == RHS.SuperResolution &&
                Features        == RHS.Features        &&
                memcmp(Description, RHS.Description, sizeof(Description)) == 0;
     }