summaryrefslogtreecommitdiffstats
path: root/tools/gfx/vulkan/vk-device-queue.h
blob: 174e208503c3b91afd135297ceea7f07cb560da6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
// vk-device-queue.h
#pragma once

#include "vk-api.h"
#include "vk-descriptor-allocator.h"

namespace gfx
{

struct VulkanDeviceQueue
{
    enum
    {
        kMaxCommandBuffers = 8,
    };

    enum class EventType
    {
        BeginFrame,
        EndFrame,
        CountOf,
    };

    /// Initialize - must be called before anything else can be done
    SlangResult init(const VulkanApi& api, VkQueue queue, int queueIndex);

    /// Flushes the current command list, and steps to next (internally this is equivalent to a
    /// stepA followed by stepB)
    void flush();
    /// Performs a full flush, and then waits for idle.
    void flushAndWait();

    /// Blocks until all work submitted to GPU has completed
    void waitForIdle() { m_api->vkQueueWaitIdle(m_queue); }

    /// Get the graphics queue index (as set on init)
    int getQueueIndex() const { return m_queueIndex; }

    /// Make the specified event 'current' - meaning it's semaphore must be waited on
    VkSemaphore makeCurrent(EventType eventType);
    VkSemaphore getSemaphore(EventType eventType);
    /// Makes the event no longer required to be waited on
    void makeCompleted(EventType eventType);
    /// Returns true if the event is already current
    SLANG_FORCE_INLINE bool isCurrent(EventType eventType) const
    {
        return m_currentSemaphores[int(eventType)] != VK_NULL_HANDLE;
    }

    /// Get the command buffer
    VkCommandBuffer getCommandBuffer() const { return m_commandBuffer; }

    /// Get the queue
    VkQueue getQueue() const { return m_queue; }

    /// Get the API
    const VulkanApi* getApi() const { return m_api; }

    /// Flushes the current command list
    void flushStepA();
    /// Steps to next command buffer and opens. May block if command buffer is still in use
    void flushStepB();

    /// Destroy the device queue
    void destroy();

    /// True if the queue appears to be valid and has been initialized
    bool isValid() const { return m_api != nullptr; }

    /// Dtor
    ~VulkanDeviceQueue();

protected:
    struct Fence
    {
        VkFence fence;
        bool active;
        uint64_t value;
    };

    void _updateFenceAtIndex(int fenceIndex, bool blocking);

    VkQueue m_queue = VK_NULL_HANDLE;

    int m_numCommandBuffers = 0;
    int m_commandBufferIndex = 0;
    // There are the same amount of command buffers as fences
    VkCommandPool m_commandPools[kMaxCommandBuffers] = {VK_NULL_HANDLE};
    VkCommandBuffer m_commandBuffers[kMaxCommandBuffers] = {VK_NULL_HANDLE};

    Fence m_fences[kMaxCommandBuffers] = {{VK_NULL_HANDLE, 0, 0u}};

    VkCommandBuffer m_commandBuffer = VK_NULL_HANDLE;
    VkCommandPool m_commandPool = VK_NULL_HANDLE;
    VkSemaphore m_semaphores[int(EventType::CountOf)];
    VkSemaphore m_currentSemaphores[int(EventType::CountOf)];

    uint64_t m_lastFenceCompleted = 1;
    uint64_t m_nextFenceValue = 2;

    int m_queueIndex = 0;

    const VulkanApi* m_api = nullptr;
};

} // namespace gfx