1 //
2 // Copyright (c) 2017-2020 Advanced Micro Devices, Inc. All rights reserved.
3 //
4 // Permission is hereby granted, free of charge, to any person obtaining a copy
5 // of this software and associated documentation files (the "Software"), to deal
6 // in the Software without restriction, including without limitation the rights
7 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 // copies of the Software, and to permit persons to whom the Software is
9 // furnished to do so, subject to the following conditions:
10 //
11 // The above copyright notice and this permission notice shall be included in
12 // all copies or substantial portions of the Software.
13 //
14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 // THE SOFTWARE.
21 //
22
23 #ifndef COMMON_H_
24 #define COMMON_H_
25
26 #include "VmaUsage.h"
27
28 #ifdef _WIN32
29
30 #include <iostream>
31 #include <fstream>
32 #include <vector>
33 #include <memory>
34 #include <algorithm>
35 #include <numeric>
36 #include <array>
37 #include <type_traits>
38 #include <utility>
39 #include <chrono>
40 #include <string>
41 #include <exception>
42
43 #include <cassert>
44 #include <cstdlib>
45 #include <cstdio>
46 #include <cstdarg>
47
48 typedef std::chrono::high_resolution_clock::time_point time_point;
49 typedef std::chrono::high_resolution_clock::duration duration;
50
51 #ifdef _DEBUG
52 #define TEST(expr) do { \
53 if(!(expr)) { \
54 assert(0 && #expr); \
55 } \
56 } while(0)
57 #else
58 #define TEST(expr) do { \
59 if(!(expr)) { \
60 throw std::runtime_error("TEST FAILED: " #expr); \
61 } \
62 } while(0)
63 #endif
64
65 #define ERR_GUARD_VULKAN(expr) TEST((expr) >= 0)
66
67 extern VkInstance g_hVulkanInstance;
68 extern VkPhysicalDevice g_hPhysicalDevice;
69 extern VkDevice g_hDevice;
70 extern VkInstance g_hVulkanInstance;
71 extern VmaAllocator g_hAllocator;
72 extern bool g_MemoryAliasingWarningEnabled;
73 extern bool VK_AMD_device_coherent_memory_enabled;
74
75 void SetAllocatorCreateInfo(VmaAllocatorCreateInfo& outInfo);
76
ToFloatSeconds(duration d)77 inline float ToFloatSeconds(duration d)
78 {
79 return std::chrono::duration_cast<std::chrono::duration<float>>(d).count();
80 }
81
82 template <typename T>
ceil_div(T x,T y)83 inline T ceil_div(T x, T y)
84 {
85 return (x+y-1) / y;
86 }
87 template <typename T>
round_div(T x,T y)88 inline T round_div(T x, T y)
89 {
90 return (x+y/(T)2) / y;
91 }
92
93 template <typename T>
align_up(T val,T align)94 static inline T align_up(T val, T align)
95 {
96 return (val + align - 1) / align * align;
97 }
98
99 static const float PI = 3.14159265358979323846264338327950288419716939937510582f;
100
101 template<typename MainT, typename NewT>
PnextChainPushFront(MainT * mainStruct,NewT * newStruct)102 inline void PnextChainPushFront(MainT* mainStruct, NewT* newStruct)
103 {
104 newStruct->pNext = mainStruct->pNext;
105 mainStruct->pNext = newStruct;
106 }
107 template<typename MainT, typename NewT>
PnextChainPushBack(MainT * mainStruct,NewT * newStruct)108 inline void PnextChainPushBack(MainT* mainStruct, NewT* newStruct)
109 {
110 struct VkAnyStruct
111 {
112 VkStructureType sType;
113 void* pNext;
114 };
115 VkAnyStruct* lastStruct = (VkAnyStruct*)mainStruct;
116 while(lastStruct->pNext != nullptr)
117 {
118 lastStruct = (VkAnyStruct*)lastStruct->pNext;
119 }
120 newStruct->pNext = nullptr;
121 lastStruct->pNext = newStruct;
122 }
123
124 struct vec3
125 {
126 float x, y, z;
127
vec3vec3128 vec3() { }
vec3vec3129 vec3(float x, float y, float z) : x(x), y(y), z(z) { }
130
131 float& operator[](uint32_t index) { return *(&x + index); }
132 const float& operator[](uint32_t index) const { return *(&x + index); }
133
134 vec3 operator+(const vec3& rhs) const { return vec3(x + rhs.x, y + rhs.y, z + rhs.z); }
135 vec3 operator-(const vec3& rhs) const { return vec3(x - rhs.x, y - rhs.y, z - rhs.z); }
136 vec3 operator*(float s) const { return vec3(x * s, y * s, z * s); }
137
Normalizedvec3138 vec3 Normalized() const
139 {
140 return (*this) * (1.f / sqrt(x * x + y * y + z * z));
141 }
142 };
143
Dot(const vec3 & lhs,const vec3 & rhs)144 inline float Dot(const vec3& lhs, const vec3& rhs)
145 {
146 return lhs.x * rhs.x + lhs.y * rhs.y + lhs.z * rhs.z;
147 }
Cross(const vec3 & lhs,const vec3 & rhs)148 inline vec3 Cross(const vec3& lhs, const vec3& rhs)
149 {
150 return vec3(
151 lhs.y * rhs.z - lhs.z * rhs.y,
152 lhs.z * rhs.x - lhs.x * rhs.z,
153 lhs.x * rhs.y - lhs.y * rhs.x);
154 }
155
156 struct vec4
157 {
158 float x, y, z, w;
159
vec4vec4160 vec4() { }
vec4vec4161 vec4(float x, float y, float z, float w) : x(x), y(y), z(z), w(w) { }
vec4vec4162 vec4(const vec3& v, float w) : x(v.x), y(v.y), z(v.z), w(w) { }
163
164 float& operator[](uint32_t index) { return *(&x + index); }
165 const float& operator[](uint32_t index) const { return *(&x + index); }
166 };
167
168 struct mat4
169 {
170 union
171 {
172 struct
173 {
174 float _11, _12, _13, _14;
175 float _21, _22, _23, _24;
176 float _31, _32, _33, _34;
177 float _41, _42, _43, _44;
178 };
179 float m[4][4]; // [row][column]
180 };
181
mat4mat4182 mat4() { }
183
mat4mat4184 mat4(
185 float _11, float _12, float _13, float _14,
186 float _21, float _22, float _23, float _24,
187 float _31, float _32, float _33, float _34,
188 float _41, float _42, float _43, float _44) :
189 _11(_11), _12(_12), _13(_13), _14(_14),
190 _21(_21), _22(_22), _23(_23), _24(_24),
191 _31(_31), _32(_32), _33(_33), _34(_34),
192 _41(_41), _42(_42), _43(_43), _44(_44)
193 {
194 }
195
mat4mat4196 mat4(
197 const vec4& row1,
198 const vec4& row2,
199 const vec4& row3,
200 const vec4& row4) :
201 _11(row1.x), _12(row1.y), _13(row1.z), _14(row1.w),
202 _21(row2.x), _22(row2.y), _23(row2.z), _24(row2.w),
203 _31(row3.x), _32(row3.y), _33(row3.z), _34(row3.w),
204 _41(row4.x), _42(row4.y), _43(row4.z), _44(row4.w)
205 {
206 }
207
208 mat4 operator*(const mat4 &rhs) const
209 {
210 return mat4(
211 _11 * rhs._11 + _12 * rhs._21 + _13 * rhs._31 + _14 * rhs._41,
212 _11 * rhs._12 + _12 * rhs._22 + _13 * rhs._32 + _14 * rhs._42,
213 _11 * rhs._13 + _12 * rhs._23 + _13 * rhs._33 + _14 * rhs._43,
214 _11 * rhs._14 + _12 * rhs._24 + _13 * rhs._34 + _14 * rhs._44,
215
216 _21 * rhs._11 + _22 * rhs._21 + _23 * rhs._31 + _24 * rhs._41,
217 _21 * rhs._12 + _22 * rhs._22 + _23 * rhs._32 + _24 * rhs._42,
218 _21 * rhs._13 + _22 * rhs._23 + _23 * rhs._33 + _24 * rhs._43,
219 _21 * rhs._14 + _22 * rhs._24 + _23 * rhs._34 + _24 * rhs._44,
220
221 _31 * rhs._11 + _32 * rhs._21 + _33 * rhs._31 + _34 * rhs._41,
222 _31 * rhs._12 + _32 * rhs._22 + _33 * rhs._32 + _34 * rhs._42,
223 _31 * rhs._13 + _32 * rhs._23 + _33 * rhs._33 + _34 * rhs._43,
224 _31 * rhs._14 + _32 * rhs._24 + _33 * rhs._34 + _34 * rhs._44,
225
226 _41 * rhs._11 + _42 * rhs._21 + _43 * rhs._31 + _44 * rhs._41,
227 _41 * rhs._12 + _42 * rhs._22 + _43 * rhs._32 + _44 * rhs._42,
228 _41 * rhs._13 + _42 * rhs._23 + _43 * rhs._33 + _44 * rhs._43,
229 _41 * rhs._14 + _42 * rhs._24 + _43 * rhs._34 + _44 * rhs._44);
230 }
231
RotationYmat4232 static mat4 RotationY(float angle)
233 {
234 const float s = sin(angle), c = cos(angle);
235 return mat4(
236 c, 0.f, -s, 0.f,
237 0.f, 1.f, 0.f, 0.f,
238 s, 0.f, c, 0.f,
239 0.f, 0.f, 0.f, 1.f);
240 }
241
Perspectivemat4242 static mat4 Perspective(float fovY, float aspectRatio, float zNear, float zFar)
243 {
244 float yScale = 1.0f / tan(fovY * 0.5f);
245 float xScale = yScale / aspectRatio;
246 return mat4(
247 xScale, 0.0f, 0.0f, 0.0f,
248 0.0f, yScale, 0.0f, 0.0f,
249 0.0f, 0.0f, zFar / (zFar - zNear), 1.0f,
250 0.0f, 0.0f, -zNear * zFar / (zFar - zNear), 0.0f);
251 }
252
LookAtmat4253 static mat4 LookAt(vec3 at, vec3 eye, vec3 up)
254 {
255 vec3 zAxis = (at - eye).Normalized();
256 vec3 xAxis = Cross(up, zAxis).Normalized();
257 vec3 yAxis = Cross(zAxis, xAxis);
258 return mat4(
259 xAxis.x, yAxis.x, zAxis.x, 0.0f,
260 xAxis.y, yAxis.y, zAxis.y, 0.0f,
261 xAxis.z, yAxis.z, zAxis.z, 0.0f,
262 -Dot(xAxis, eye), -Dot(yAxis, eye), -Dot(zAxis, eye), 1.0f);
263 }
264 };
265
266 class RandomNumberGenerator
267 {
268 public:
RandomNumberGenerator()269 RandomNumberGenerator() : m_Value{GetTickCount()} {}
RandomNumberGenerator(uint32_t seed)270 RandomNumberGenerator(uint32_t seed) : m_Value{seed} { }
Seed(uint32_t seed)271 void Seed(uint32_t seed) { m_Value = seed; }
Generate()272 uint32_t Generate() { return GenerateFast() ^ (GenerateFast() >> 7); }
273
274 private:
275 uint32_t m_Value;
GenerateFast()276 uint32_t GenerateFast() { return m_Value = (m_Value * 196314165 + 907633515); }
277 };
278
279 // Wrapper for RandomNumberGenerator compatible with STL "UniformRandomNumberGenerator" idea.
280 struct MyUniformRandomNumberGenerator
281 {
282 typedef uint32_t result_type;
MyUniformRandomNumberGeneratorMyUniformRandomNumberGenerator283 MyUniformRandomNumberGenerator(RandomNumberGenerator& gen) : m_Gen(gen) { }
minMyUniformRandomNumberGenerator284 static uint32_t min() { return 0; }
maxMyUniformRandomNumberGenerator285 static uint32_t max() { return UINT32_MAX; }
operatorMyUniformRandomNumberGenerator286 uint32_t operator()() { return m_Gen.Generate(); }
287
288 private:
289 RandomNumberGenerator& m_Gen;
290 };
291
292 void ReadFile(std::vector<char>& out, const char* fileName);
293
294 enum class CONSOLE_COLOR
295 {
296 INFO,
297 NORMAL,
298 WARNING,
299 ERROR_,
300 COUNT
301 };
302
303 void SetConsoleColor(CONSOLE_COLOR color);
304
305 void PrintMessage(CONSOLE_COLOR color, const char* msg);
306 void PrintMessage(CONSOLE_COLOR color, const wchar_t* msg);
307
Print(const char * msg)308 inline void Print(const char* msg) { PrintMessage(CONSOLE_COLOR::NORMAL, msg); }
Print(const wchar_t * msg)309 inline void Print(const wchar_t* msg) { PrintMessage(CONSOLE_COLOR::NORMAL, msg); }
PrintWarning(const char * msg)310 inline void PrintWarning(const char* msg) { PrintMessage(CONSOLE_COLOR::WARNING, msg); }
PrintWarning(const wchar_t * msg)311 inline void PrintWarning(const wchar_t* msg) { PrintMessage(CONSOLE_COLOR::WARNING, msg); }
PrintError(const char * msg)312 inline void PrintError(const char* msg) { PrintMessage(CONSOLE_COLOR::ERROR_, msg); }
PrintError(const wchar_t * msg)313 inline void PrintError(const wchar_t* msg) { PrintMessage(CONSOLE_COLOR::ERROR_, msg); }
314
315 void PrintMessageV(CONSOLE_COLOR color, const char* format, va_list argList);
316 void PrintMessageV(CONSOLE_COLOR color, const wchar_t* format, va_list argList);
317 void PrintMessageF(CONSOLE_COLOR color, const char* format, ...);
318 void PrintMessageF(CONSOLE_COLOR color, const wchar_t* format, ...);
319 void PrintWarningF(const char* format, ...);
320 void PrintWarningF(const wchar_t* format, ...);
321 void PrintErrorF(const char* format, ...);
322 void PrintErrorF(const wchar_t* format, ...);
323
324 void SaveFile(const wchar_t* filePath, const void* data, size_t dataSize);
325
326 #endif // #ifdef _WIN32
327
328 #endif
329