liblava/liblava/base/queue.hpp at flow · mcpplibs/liblava · GitHub

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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/**
 * @file         liblava/base/queue.hpp
 * @brief        Device queue
 * @authors      Lava Block OÜ and contributors
 * @copyright    Copyright (c) 2018-present, MIT License
 */

#pragma once

#include "liblava/base/base.hpp"
#include <deque>

namespace lava {

/**
 * @brief Device queue
 */
struct queue {
    /// List of queues
    using list = std::deque<queue>;

    /// Reference to queue
    using ref = queue const&;

    /// Vulkan queue
    VkQueue vk_queue = nullptr;

    /// Queue flags
    VkQueueFlags flags = 0;

    /// Queue family index
    index family = 0;

    /// Queue priority
    r32 priority = 1.f;

    /**
     * @brief Check if queue is valid
     * @return Queue is valid or not
     */
    bool valid() const {
        return vk_queue != nullptr;
    }

    /**
     * @brief Queue priority compare operator
     * @param other     Queue to compare
     * @return Priority of queue is higher or lower and equal
     */
    bool operator<(queue const& other) const {
        return priority < other.priority;
    }
};

/// Default queue flags
constexpr VkQueueFlags const default_queue_flags = VK_QUEUE_GRAPHICS_BIT
                                                   | VK_QUEUE_COMPUTE_BIT
                                                   | VK_QUEUE_TRANSFER_BIT;

/**
 * @brief Queue information
 */
struct queue_info {
    /// List of queue informations
    using list = std::deque<queue_info>;

    /// Queue flags
    VkQueueFlags flags = default_queue_flags;

    /// Queue priority
    r32 priority = 1.f;
};

/**
 * @brief Queue family information
 */
struct queue_family_info {
    /// List of queue family informations
    using list = std::deque<queue_family_info>;

    /// Queue family index
    index family_index = 0;

    /// List of queue informations
    queue_info::list queues;

    /**
     * @brief Add a queue family information
     * @param flags       Queue flags
     * @param count       Number of queues
     * @param priority    Queue priority
     */
    void add(VkQueueFlags flags,
             ui32 count = 1,
             r32 priority = 1.f) {
        for (auto i = 0u; i < count; ++i) {
            queue_info info{flags, priority};
            queues.push_back(info);
        }
    }

    /**
     * @brief Get the count of queues
     * @return ui32    Count of queues
     */
    ui32 count() const {
        return to_ui32(queues.size());
    }

    /**
     * @brief Clear the queue information
     */
    void clear() {
        queues.clear();
    }
};

/**
 * @brief Set the default queues
 * @param list    List of queue family informations
 */
void set_default_queues(queue_family_info::list& list);

/**
 * @brief Set all queues
 * @param list          List of queue family informations
 * @param properties    List of queue family properties
 */
void set_all_queues(queue_family_info::list& list,
                    VkQueueFamilyPropertiesList const& properties);

/**
 * @brief Add queues
 * @param list          List of queue family informations
 * @param properties    List of queue family properties
 * @param flags         Queue flags
 * @param count         Number of queues
 * @param priority      Queue priority
 * @return Add was successful or failed
 */
bool add_queues(queue_family_info::list& list,
                VkQueueFamilyPropertiesList const& properties,
                VkQueueFlags flags,
                ui32 count,
                r32 priority = 1.f);

/**
 * @brief Add dedicated queues
 * @param list          List of queue family informations
 * @param properties    List of queue family properties
 * @param priority      Queue priority
 * @return Add was successful or failed
 */
bool add_dedicated_queues(queue_family_info::list& list,
                          VkQueueFamilyPropertiesList const& properties,
                          r32 priority = 1.f);

/**
 * @brief Result of queue verifications
 */
enum class verify_queues_result : index {
    ok = 0,
    empty_list,
    no_properties,
    duplicate_family_index,
    no_family_index,
    no_queues,
    too_many_queues,
    no_compatible_flags
};

/**
 * @brief Verify queues
 * @param list                     List of queue family informations
 * @param properties               List of queue family properties
 * @return verify_queues_result    Verification result
 */
verify_queues_result verify_queues(queue_family_info::list const& list,
                                   VkQueueFamilyPropertiesList const& properties);

} // namespace lava