1 | #ifndef _VULKAN_BUFFER_H
|
---|
2 | #define _VULKAN_BUFFER_H
|
---|
3 |
|
---|
4 | /*
|
---|
5 | * This class is intended to be used with Storage Buffers and Uniform Buffers.
|
---|
6 | */
|
---|
7 |
|
---|
8 | template<class T>
|
---|
9 | class VulkanBuffer {
|
---|
10 |
|
---|
11 | public:
|
---|
12 |
|
---|
13 | // TODO: Make these private (maybe make a getter for numObjects)
|
---|
14 | // Externally, they are only used in resizeBufferSet
|
---|
15 | size_t capacity;
|
---|
16 |
|
---|
17 | // temp field to help with ubo+ssbo resizing until they are added to this class
|
---|
18 | // See if I need a separate field for this or if I can use other fields to check for this
|
---|
19 | // Maybe compare uniform or storage buffer size to the size of the memory allocated here
|
---|
20 | bool resized;
|
---|
21 |
|
---|
22 | VulkanBuffer();
|
---|
23 | VulkanBuffer(size_t capacity, size_t range, size_t minOffsetAlignment);
|
---|
24 |
|
---|
25 | VulkanBuffer(const VulkanBuffer<T>&) = delete;
|
---|
26 | VulkanBuffer(VulkanBuffer<T>&& other);
|
---|
27 |
|
---|
28 | ~VulkanBuffer();
|
---|
29 |
|
---|
30 | VulkanBuffer<T>& operator=(const VulkanBuffer<T>&) = delete;
|
---|
31 | VulkanBuffer<T>& operator=(VulkanBuffer<T>&& other) noexcept;
|
---|
32 |
|
---|
33 | void resize();
|
---|
34 |
|
---|
35 | void add(T obj);
|
---|
36 |
|
---|
37 | size_t memorySize();
|
---|
38 |
|
---|
39 | private:
|
---|
40 |
|
---|
41 | size_t alignment;
|
---|
42 | size_t range;
|
---|
43 | size_t numObjects;
|
---|
44 |
|
---|
45 | T* srcData; // TODO: Rename this to something else probably and rename rawData to data
|
---|
46 | vector<T>* vData;
|
---|
47 |
|
---|
48 | // Remember that this is a pointer to the mapped video memory
|
---|
49 | // Maybe rename it to mappedData or something to make that clearer
|
---|
50 | void* rawData;
|
---|
51 |
|
---|
52 | size_t memRequirement(size_t capacity);
|
---|
53 | };
|
---|
54 |
|
---|
55 | // Currently, for SSBOs, I store the per-object values (usually just the model matrix), on each object, so they
|
---|
56 | // are not in their own array and therefore cannot be pushed to the GPU as one block. The updates must happen
|
---|
57 | // separately per object.
|
---|
58 |
|
---|
59 | // Since Sascha WIllems' dynamic UBO example works the same way (iirc), I can implement dynamic UBOs like that as well
|
---|
60 | // for now. Would be nice to plan for potentially storing the ubo data on the CPU in a contiguous block in the future,
|
---|
61 | // assuming that would make updates easier. Keep in mind that this only makes sense if all or most of the objects
|
---|
62 | // in the ubo get updated every frame.
|
---|
63 |
|
---|
64 | // ============================= TODO: Also, check when it makes sense to have a staging buffer for copying data to the GPU
|
---|
65 | // and see if I actually need to use it everywhere I currently am. I think this is mentioned in Sascha WIllems dubo example
|
---|
66 | // or some other Vulkan website I recently bookmarked
|
---|
67 |
|
---|
68 | template<class T>
|
---|
69 | VulkanBuffer<T>::VulkanBuffer()
|
---|
70 | : alignment(0)
|
---|
71 | , range(0)
|
---|
72 | , capacity(0)
|
---|
73 | , numObjects(0)
|
---|
74 | , resized(false)
|
---|
75 | , srcData(nullptr)
|
---|
76 | , rawData(nullptr)
|
---|
77 | , vData(nullptr) {
|
---|
78 | }
|
---|
79 |
|
---|
80 | template<class T>
|
---|
81 | VulkanBuffer<T>::VulkanBuffer(size_t capacity, size_t range, size_t minOffsetAlignment)
|
---|
82 | : alignment(range)
|
---|
83 | , range(range / sizeof(T))
|
---|
84 | , capacity(capacity)
|
---|
85 | , numObjects(0)
|
---|
86 | , resized(false)
|
---|
87 | , srcData(nullptr)
|
---|
88 | , rawData(nullptr)
|
---|
89 | , vData(nullptr) {
|
---|
90 | if (minOffsetAlignment > 0) {
|
---|
91 | alignment = (alignment + minOffsetAlignment - 1) & ~(minOffsetAlignment - 1);
|
---|
92 | }
|
---|
93 |
|
---|
94 | srcData = (T*)malloc(memRequirement(capacity));
|
---|
95 | }
|
---|
96 |
|
---|
97 | template<class T>
|
---|
98 | VulkanBuffer<T>::VulkanBuffer(VulkanBuffer<T>&& other) {
|
---|
99 | // TODO: Implement
|
---|
100 | }
|
---|
101 |
|
---|
102 | template<class T>
|
---|
103 | VulkanBuffer<T>::~VulkanBuffer() {
|
---|
104 | if (srcData != nullptr) {
|
---|
105 | free(srcData);
|
---|
106 | }
|
---|
107 | }
|
---|
108 |
|
---|
109 | template<class T>
|
---|
110 | VulkanBuffer<T>& VulkanBuffer<T>::operator=(VulkanBuffer<T>&& other) noexcept {
|
---|
111 | if (this != &other) {
|
---|
112 | capacity = other.capacity;
|
---|
113 | numObjects = other.numObjects;
|
---|
114 | resized = other.resized;
|
---|
115 |
|
---|
116 | alignment = other.alignment;
|
---|
117 | range = other.range;
|
---|
118 |
|
---|
119 | if (srcData != nullptr) {
|
---|
120 | free(srcData);
|
---|
121 | }
|
---|
122 |
|
---|
123 | srcData = other.srcData;
|
---|
124 |
|
---|
125 | other.capacity = 0;
|
---|
126 | other.numObjects = 0;
|
---|
127 | other.range = 0;
|
---|
128 |
|
---|
129 | other.srcData = nullptr;
|
---|
130 | }
|
---|
131 |
|
---|
132 | return *this;
|
---|
133 | }
|
---|
134 |
|
---|
135 | template<class T>
|
---|
136 | void VulkanBuffer<T>::resize() {
|
---|
137 | resized = false;
|
---|
138 | }
|
---|
139 |
|
---|
140 | template<class T>
|
---|
141 | void VulkanBuffer<T>::add(T obj) {
|
---|
142 | if (numObjects == capacity) {
|
---|
143 | // Once I add Vulkan buffer objects in here, make sure this doesn't overlap with resizeBufferSet
|
---|
144 | resized = true;
|
---|
145 |
|
---|
146 | capacity *= 2;
|
---|
147 | }
|
---|
148 |
|
---|
149 | numObjects++;
|
---|
150 | }
|
---|
151 |
|
---|
152 | template<class T>
|
---|
153 | size_t VulkanBuffer<T>::memorySize() {
|
---|
154 | return memRequirement(capacity);
|
---|
155 | }
|
---|
156 |
|
---|
157 | template<class T>
|
---|
158 | size_t VulkanBuffer<T>::memRequirement(size_t capacity) {
|
---|
159 | return (capacity / range) * alignment + (capacity % range) * sizeof(T);
|
---|
160 | }
|
---|
161 |
|
---|
162 | #endif // _VULKAN_BUFFER_H
|
---|