/*
 *  Copyright 2019-2021 Diligent Graphics LLC
 *  Copyright 2015-2019 Egor Yusov
 *  
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *  
 *      http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *  In no event and under no legal theory, whether in tort (including negligence), 
 *  contract, or otherwise, unless required by applicable law (such as deliberate 
 *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
 *  liable for any damages, including any direct, indirect, special, incidental, 
 *  or consequential damages of any character arising as a result of this License or 
 *  out of the use or inability to use the software (including but not limited to damages 
 *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and 
 *  all other commercial damages or losses), even if such Contributor has been advised 
 *  of the possibility of such damages.
 */

#pragma once

/// \file
/// Definition of the Diligent::ICommandQueueVk interface

#include "../../../Primitives/interface/Object.h"

DILIGENT_BEGIN_NAMESPACE(Diligent)

// {9FBF582F-3069-41B9-AC05-344D5AF5CE8C}
static const INTERFACE_ID IID_CommandQueueVk =
    {0x9fbf582f, 0x3069, 0x41b9, {0xac, 0x5, 0x34, 0x4d, 0x5a, 0xf5, 0xce, 0x8c}};

#define DILIGENT_INTERFACE_NAME ICommandQueueVk
#include "../../../Primitives/interface/DefineInterfaceHelperMacros.h"

#define ICommandQueueVkInclusiveMethods \
    IObjectInclusiveMethods;            \
    ICommandQueueVkMethods CommandQueueVk

// clang-format off

/// Command queue interface
DILIGENT_BEGIN_INTERFACE(ICommandQueueVk, IObject)
{
    /// Returns the fence value that will be signaled next time
    VIRTUAL Uint64 METHOD(GetNextFenceValue)(THIS) CONST PURE;

    /// Submits a given command buffer to the command queue

    /// \return Fence value associated with the submitted command buffer
    VIRTUAL Uint64 METHOD(SubmitCmdBuffer)(THIS_
                                           VkCommandBuffer cmdBuffer) PURE;

    /// Submits a given chunk of work to the command queue

    /// \return Fence value associated with the submitted command buffer
    VIRTUAL Uint64 METHOD(Submit)(THIS_
                                  const VkSubmitInfo REF SubmitInfo) PURE;

    /// Presents the current swap chain image on the screen
    VIRTUAL VkResult METHOD(Present)(THIS_
                                     const VkPresentInfoKHR REF PresentInfo) PURE;

    /// Returns Vulkan command queue. May return VK_NULL_HANDLE if queue is anavailable
    VIRTUAL VkQueue METHOD(GetVkQueue)(THIS) PURE;

    /// Returns vulkan command queue family index
    VIRTUAL uint32_t METHOD(GetQueueFamilyIndex)(THIS) CONST PURE;

    /// Returns value of the last completed fence
    VIRTUAL Uint64 METHOD(GetCompletedFenceValue)(THIS) PURE;

    /// Blocks execution until all pending GPU commands are complete

    /// \return Last completed fence value
    VIRTUAL Uint64 METHOD(WaitForIdle)(THIS) PURE;

    /// Signals the given fence
    VIRTUAL void METHOD(SignalFence)(THIS_
                                     VkFence vkFence) PURE;
};
DILIGENT_END_INTERFACE

#include "../../../Primitives/interface/UndefInterfaceHelperMacros.h"

#if DILIGENT_C_INTERFACE

// clang-format off

#    define ICommandQueueVk_GetNextFenceValue(This)      CALL_IFACE_METHOD(CommandQueueVk, GetNextFenceValue,      This)
#    define ICommandQueueVk_SubmitCmdBuffer(This, ...)   CALL_IFACE_METHOD(CommandQueueVk, SubmitCmdBuffer,        This, __VA_ARGS__)
#    define ICommandQueueVk_Submit(This, ...)            CALL_IFACE_METHOD(CommandQueueVk, Submit,                 This, __VA_ARGS__)
#    define ICommandQueueVk_Present(This, ...)           CALL_IFACE_METHOD(CommandQueueVk, Present,                This, __VA_ARGS__)
#    define ICommandQueueVk_GetVkQueue(This)             CALL_IFACE_METHOD(CommandQueueVk, GetVkQueue,             This)
#    define ICommandQueueVk_GetQueueFamilyIndex(This)    CALL_IFACE_METHOD(CommandQueueVk, GetQueueFamilyIndex,    This)
#    define ICommandQueueVk_GetCompletedFenceValue(This) CALL_IFACE_METHOD(CommandQueueVk, GetCompletedFenceValue, This)
#    define ICommandQueueVk_WaitForIdle(This)            CALL_IFACE_METHOD(CommandQueueVk, WaitForIdle,            This)
#    define ICommandQueueVk_SignalFence(This, ...)       CALL_IFACE_METHOD(CommandQueueVk, SignalFence,            This, __VA_ARGS__)

// clang-format on

#endif

DILIGENT_END_NAMESPACE // namespace Diligent