From 263df093a5a95c1d080b0b3aae6bb95ec96700f3 Mon Sep 17 00:00:00 2001 From: Benjamin Praud Date: Sun, 27 Feb 2022 20:28:55 +0100 Subject: [PATCH 1/8] feat: add start of documentation --- conanfile.txt | 1 + docs/html/_class_utils_8hpp.html | 198 ++ docs/html/_class_utils_8hpp_source.html | 103 + docs/html/_context_g_l_f_w_8hpp.html | 73 + docs/html/_context_g_l_f_w_8hpp_source.html | 105 + docs/html/_context_vulkan_8hpp.html | 78 + docs/html/_context_vulkan_8hpp_source.html | 299 +++ docs/html/_exceptions_8hpp.html | 140 ++ docs/html/_exceptions_8hpp_source.html | 194 ++ docs/html/_frame_manager_8hpp.html | 112 + docs/html/_frame_manager_8hpp_source.html | 131 ++ docs/html/_keyboard_8hpp.html | 233 +++ docs/html/_keyboard_8hpp_source.html | 358 ++++ docs/html/_mat3_8hpp.html | 76 + docs/html/_mat3_8hpp_source.html | 144 ++ docs/html/_mouse_8hpp.html | 96 + docs/html/_mouse_8hpp_source.html | 136 ++ docs/html/_objects_8hpp.html | 69 + docs/html/_objects_8hpp_source.html | 103 + docs/html/_rect_8hpp.html | 86 + docs/html/_rect_8hpp_source.html | 152 ++ docs/html/_scoped_profiler_8hpp.html | 160 ++ docs/html/_scoped_profiler_8hpp_source.html | 122 ++ docs/html/_shader_8hpp.html | 74 + docs/html/_shader_8hpp_source.html | 111 + docs/html/_time_8hpp.html | 76 + docs/html/_time_8hpp_source.html | 87 + docs/html/_utils_8hpp.html | 77 + docs/html/_utils_8hpp_source.html | 87 + docs/html/_vec2_8hpp.html | 107 + docs/html/_vec2_8hpp_source.html | 199 ++ docs/html/_vec3_8hpp.html | 107 + docs/html/_vec3_8hpp_source.html | 204 ++ docs/html/_window_8hpp.html | 75 + docs/html/_window_8hpp_source.html | 134 ++ docs/html/annotated.html | 75 + docs/html/bc_s.png | Bin 0 -> 676 bytes docs/html/bdwn.png | Bin 0 -> 147 bytes docs/html/class_type_checker.html | 62 + docs/html/classes.html | 90 + ...classvulk_1_1_context_g_l_f_w-members.html | 61 + docs/html/classvulk_1_1_context_g_l_f_w.html | 147 ++ .../classvulk_1_1_context_vulkan-members.html | 63 + docs/html/classvulk_1_1_context_vulkan.html | 196 ++ .../html/classvulk_1_1_exception-members.html | 63 + docs/html/classvulk_1_1_exception.html | 234 +++ docs/html/classvulk_1_1_exception.png | Bin 0 -> 475 bytes .../classvulk_1_1_frame_manager-members.html | 67 + docs/html/classvulk_1_1_frame_manager.html | 288 +++ ...assvulk_1_1_g_l_f_w_exception-members.html | 60 + .../html/classvulk_1_1_g_l_f_w_exception.html | 134 ++ docs/html/classvulk_1_1_g_l_f_w_exception.png | Bin 0 -> 569 bytes docs/html/classvulk_1_1_keyboard-members.html | 63 + docs/html/classvulk_1_1_keyboard.html | 206 ++ docs/html/classvulk_1_1_mouse-members.html | 63 + docs/html/classvulk_1_1_mouse.html | 206 ++ docs/html/classvulk_1_1_shader-members.html | 62 + docs/html/classvulk_1_1_shader.html | 172 ++ ...lassvulk_1_1_vulkan_exception-members.html | 61 + docs/html/classvulk_1_1_vulkan_exception.html | 158 ++ docs/html/classvulk_1_1_vulkan_exception.png | Bin 0 -> 600 bytes docs/html/classvulk_1_1_window-members.html | 71 + docs/html/classvulk_1_1_window.html | 461 +++++ ..._1_1utils_1_1_scoped_profiler-members.html | 68 + ...lassvulk_1_1utils_1_1_scoped_profiler.html | 297 +++ docs/html/closed.png | Bin 0 -> 132 bytes .../dir_5a30104352ef4255dc24354b02eb2d20.html | 61 + .../dir_97aefd0d527b934f1d99a682da8fe6a9.html | 61 + .../dir_b80377379080ab8697acea2877ef94f6.html | 63 + .../dir_bbfa40afa4c57c6dadf08b9016d8766e.html | 94 + docs/html/doc.png | Bin 0 -> 746 bytes docs/html/doxygen.css | 1841 +++++++++++++++++ docs/html/doxygen.svg | 26 + docs/html/dynsections.js | 121 ++ docs/html/files.html | 76 + docs/html/folderclosed.png | Bin 0 -> 616 bytes docs/html/folderopen.png | Bin 0 -> 597 bytes docs/html/functions.html | 232 +++ docs/html/functions_func.html | 185 ++ docs/html/functions_rela.html | 51 + docs/html/functions_type.html | 58 + docs/html/functions_vars.html | 64 + docs/html/globals.html | 61 + docs/html/globals_defs.html | 60 + docs/html/globals_func.html | 51 + docs/html/hierarchy.html | 75 + docs/html/index.html | 51 + docs/html/jquery.js | 35 + docs/html/menu.js | 127 ++ docs/html/menudata.js | 101 + docs/html/namespacemembers.html | 112 + docs/html/namespacemembers_enum.html | 52 + docs/html/namespacemembers_func.html | 57 + docs/html/namespacemembers_type.html | 65 + docs/html/namespaces.html | 72 + docs/html/namespacevulk.html | 1310 ++++++++++++ docs/html/namespacevulk_1_1utils.html | 121 ++ docs/html/nav_f.png | Bin 0 -> 153 bytes docs/html/nav_g.png | Bin 0 -> 95 bytes docs/html/nav_h.png | Bin 0 -> 98 bytes docs/html/open.png | Bin 0 -> 123 bytes docs/html/splitbar.png | Bin 0 -> 314 bytes .../struct_uniform_buffer_object-members.html | 57 + docs/html/struct_uniform_buffer_object.html | 112 + docs/html/struct_vertex-members.html | 59 + docs/html/struct_vertex.html | 176 ++ docs/html/structvulk_1_1_mat3-members.html | 67 + docs/html/structvulk_1_1_mat3.html | 400 ++++ docs/html/structvulk_1_1_rect-members.html | 70 + docs/html/structvulk_1_1_rect.html | 442 ++++ docs/html/structvulk_1_1_vec2-members.html | 74 + docs/html/structvulk_1_1_vec2.html | 574 +++++ docs/html/structvulk_1_1_vec3-members.html | 75 + docs/html/structvulk_1_1_vec3.html | 598 ++++++ docs/html/sync_off.png | Bin 0 -> 853 bytes docs/html/sync_on.png | Bin 0 -> 845 bytes docs/html/tab_a.png | Bin 0 -> 142 bytes docs/html/tab_b.png | Bin 0 -> 169 bytes docs/html/tab_h.png | Bin 0 -> 177 bytes docs/html/tab_s.png | Bin 0 -> 184 bytes docs/html/tabs.css | 1 + 121 files changed, 15923 insertions(+) create mode 100644 docs/html/_class_utils_8hpp.html create mode 100644 docs/html/_class_utils_8hpp_source.html create mode 100644 docs/html/_context_g_l_f_w_8hpp.html create mode 100644 docs/html/_context_g_l_f_w_8hpp_source.html create mode 100644 docs/html/_context_vulkan_8hpp.html create mode 100644 docs/html/_context_vulkan_8hpp_source.html create mode 100644 docs/html/_exceptions_8hpp.html create mode 100644 docs/html/_exceptions_8hpp_source.html create mode 100644 docs/html/_frame_manager_8hpp.html create mode 100644 docs/html/_frame_manager_8hpp_source.html create mode 100644 docs/html/_keyboard_8hpp.html create mode 100644 docs/html/_keyboard_8hpp_source.html create mode 100644 docs/html/_mat3_8hpp.html create mode 100644 docs/html/_mat3_8hpp_source.html create mode 100644 docs/html/_mouse_8hpp.html create mode 100644 docs/html/_mouse_8hpp_source.html create mode 100644 docs/html/_objects_8hpp.html create mode 100644 docs/html/_objects_8hpp_source.html create mode 100644 docs/html/_rect_8hpp.html create mode 100644 docs/html/_rect_8hpp_source.html create mode 100644 docs/html/_scoped_profiler_8hpp.html create mode 100644 docs/html/_scoped_profiler_8hpp_source.html create mode 100644 docs/html/_shader_8hpp.html create mode 100644 docs/html/_shader_8hpp_source.html create mode 100644 docs/html/_time_8hpp.html create mode 100644 docs/html/_time_8hpp_source.html create mode 100644 docs/html/_utils_8hpp.html create mode 100644 docs/html/_utils_8hpp_source.html create mode 100644 docs/html/_vec2_8hpp.html create mode 100644 docs/html/_vec2_8hpp_source.html create mode 100644 docs/html/_vec3_8hpp.html create mode 100644 docs/html/_vec3_8hpp_source.html create mode 100644 docs/html/_window_8hpp.html create mode 100644 docs/html/_window_8hpp_source.html create mode 100644 docs/html/annotated.html create mode 100644 docs/html/bc_s.png create mode 100644 docs/html/bdwn.png create mode 100644 docs/html/class_type_checker.html create mode 100644 docs/html/classes.html create mode 100644 docs/html/classvulk_1_1_context_g_l_f_w-members.html create mode 100644 docs/html/classvulk_1_1_context_g_l_f_w.html create mode 100644 docs/html/classvulk_1_1_context_vulkan-members.html create mode 100644 docs/html/classvulk_1_1_context_vulkan.html create mode 100644 docs/html/classvulk_1_1_exception-members.html create mode 100644 docs/html/classvulk_1_1_exception.html create mode 100644 docs/html/classvulk_1_1_exception.png create mode 100644 docs/html/classvulk_1_1_frame_manager-members.html create mode 100644 docs/html/classvulk_1_1_frame_manager.html create mode 100644 docs/html/classvulk_1_1_g_l_f_w_exception-members.html create mode 100644 docs/html/classvulk_1_1_g_l_f_w_exception.html create mode 100644 docs/html/classvulk_1_1_g_l_f_w_exception.png create mode 100644 docs/html/classvulk_1_1_keyboard-members.html create mode 100644 docs/html/classvulk_1_1_keyboard.html create mode 100644 docs/html/classvulk_1_1_mouse-members.html create mode 100644 docs/html/classvulk_1_1_mouse.html create mode 100644 docs/html/classvulk_1_1_shader-members.html create mode 100644 docs/html/classvulk_1_1_shader.html create mode 100644 docs/html/classvulk_1_1_vulkan_exception-members.html create mode 100644 docs/html/classvulk_1_1_vulkan_exception.html create mode 100644 docs/html/classvulk_1_1_vulkan_exception.png create mode 100644 docs/html/classvulk_1_1_window-members.html create mode 100644 docs/html/classvulk_1_1_window.html create mode 100644 docs/html/classvulk_1_1utils_1_1_scoped_profiler-members.html create mode 100644 docs/html/classvulk_1_1utils_1_1_scoped_profiler.html create mode 100644 docs/html/closed.png create mode 100644 docs/html/dir_5a30104352ef4255dc24354b02eb2d20.html create mode 100644 docs/html/dir_97aefd0d527b934f1d99a682da8fe6a9.html create mode 100644 docs/html/dir_b80377379080ab8697acea2877ef94f6.html create mode 100644 docs/html/dir_bbfa40afa4c57c6dadf08b9016d8766e.html create mode 100644 docs/html/doc.png create mode 100644 docs/html/doxygen.css create mode 100644 docs/html/doxygen.svg create mode 100644 docs/html/dynsections.js create mode 100644 docs/html/files.html create mode 100644 docs/html/folderclosed.png create mode 100644 docs/html/folderopen.png create mode 100644 docs/html/functions.html create mode 100644 docs/html/functions_func.html create mode 100644 docs/html/functions_rela.html create mode 100644 docs/html/functions_type.html create mode 100644 docs/html/functions_vars.html create mode 100644 docs/html/globals.html create mode 100644 docs/html/globals_defs.html create mode 100644 docs/html/globals_func.html create mode 100644 docs/html/hierarchy.html create mode 100644 docs/html/index.html create mode 100644 docs/html/jquery.js create mode 100644 docs/html/menu.js create mode 100644 docs/html/menudata.js create mode 100644 docs/html/namespacemembers.html create mode 100644 docs/html/namespacemembers_enum.html create mode 100644 docs/html/namespacemembers_func.html create mode 100644 docs/html/namespacemembers_type.html create mode 100644 docs/html/namespaces.html create mode 100644 docs/html/namespacevulk.html create mode 100644 docs/html/namespacevulk_1_1utils.html create mode 100644 docs/html/nav_f.png create mode 100644 docs/html/nav_g.png create mode 100644 docs/html/nav_h.png create mode 100644 docs/html/open.png create mode 100644 docs/html/splitbar.png create mode 100644 docs/html/struct_uniform_buffer_object-members.html create mode 100644 docs/html/struct_uniform_buffer_object.html create mode 100644 docs/html/struct_vertex-members.html create mode 100644 docs/html/struct_vertex.html create mode 100644 docs/html/structvulk_1_1_mat3-members.html create mode 100644 docs/html/structvulk_1_1_mat3.html create mode 100644 docs/html/structvulk_1_1_rect-members.html create mode 100644 docs/html/structvulk_1_1_rect.html create mode 100644 docs/html/structvulk_1_1_vec2-members.html create mode 100644 docs/html/structvulk_1_1_vec2.html create mode 100644 docs/html/structvulk_1_1_vec3-members.html create mode 100644 docs/html/structvulk_1_1_vec3.html create mode 100644 docs/html/sync_off.png create mode 100644 docs/html/sync_on.png create mode 100644 docs/html/tab_a.png create mode 100644 docs/html/tab_b.png create mode 100644 docs/html/tab_h.png create mode 100644 docs/html/tab_s.png create mode 100644 docs/html/tabs.css diff --git a/conanfile.txt b/conanfile.txt index e47e9d8..81eff68 100644 --- a/conanfile.txt +++ b/conanfile.txt @@ -5,6 +5,7 @@ glm/0.9.9.8 glfw/3.3.6 shaderc/2021.1 # (glslc) gtest/cci.20210126 +doxygen/1.9.2 ## These could be used for examples or the lib itself... We will disable them for now. # fmt/8.0.1 diff --git a/docs/html/_class_utils_8hpp.html b/docs/html/_class_utils_8hpp.html new file mode 100644 index 0000000..8148841 --- /dev/null +++ b/docs/html/_class_utils_8hpp.html @@ -0,0 +1,198 @@ + + + + + + + +Vulk: lib/include/Vulk/ClassUtils.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Macros
+
ClassUtils.hpp File Reference
+
+
+ +

Go to the source code of this file.

+ + + + + + + + + + + + + + +

+Macros

#define VULK_NO_COPY(ClassName)
 
#define VULK_NO_MOVE(ClassName)
 
#define VULK_NO_MOVE_OR_COPY(ClassName)
 
#define VULK_DEFAULT_COPY(ClassName)
 
#define VULK_DEFAULT_MOVE(ClassName)
 
#define VULK_DEFAULT_MOVE_AND_COPY(ClassName)
 
+

Macro Definition Documentation

+ +

◆ VULK_DEFAULT_COPY

+ +
+
+ + + + + + + + +
#define VULK_DEFAULT_COPY( ClassName)
+
+Value:
ClassName(const ClassName&) = default; \
+
ClassName& operator=(const ClassName&) = default;
+
+
+
+ +

◆ VULK_DEFAULT_MOVE

+ +
+
+ + + + + + + + +
#define VULK_DEFAULT_MOVE( ClassName)
+
+Value:
ClassName(ClassName&&) = default; \
+
ClassName& operator=(ClassName&&) = default;
+
+
+
+ +

◆ VULK_DEFAULT_MOVE_AND_COPY

+ +
+
+ + + + + + + + +
#define VULK_DEFAULT_MOVE_AND_COPY( ClassName)
+
+Value:
VULK_DEFAULT_COPY(ClassName) \
+
VULK_DEFAULT_MOVE(ClassName)
+
VULK_DEFAULT_COPY
#define VULK_DEFAULT_COPY(ClassName)
Definition: ClassUtils.hpp:34
+
+
+
+ +

◆ VULK_NO_COPY

+ +
+
+ + + + + + + + +
#define VULK_NO_COPY( ClassName)
+
+Value:
ClassName(const ClassName&) = delete; \
+
ClassName& operator=(const ClassName&) = delete;
+
+
+
+ +

◆ VULK_NO_MOVE

+ +
+
+ + + + + + + + +
#define VULK_NO_MOVE( ClassName)
+
+Value:
ClassName(ClassName&&) = delete; \
+
ClassName& operator=(ClassName&&) = delete;
+
+
+
+ +

◆ VULK_NO_MOVE_OR_COPY

+ +
+
+ + + + + + + + +
#define VULK_NO_MOVE_OR_COPY( ClassName)
+
+Value:
VULK_NO_COPY(ClassName) \
+
VULK_NO_MOVE(ClassName)
+
VULK_NO_COPY
#define VULK_NO_COPY(ClassName)
Definition: ClassUtils.hpp:22
+
+
+
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_class_utils_8hpp_source.html b/docs/html/_class_utils_8hpp_source.html new file mode 100644 index 0000000..5cff31c --- /dev/null +++ b/docs/html/_class_utils_8hpp_source.html @@ -0,0 +1,103 @@ + + + + + + + +Vulk: lib/include/Vulk/ClassUtils.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
ClassUtils.hpp
+
+
+Go to the documentation of this file.
1/*
+
2 * Copyright (c) 2021-2021 [fill name later]
+
3 *
+
4 * This software is provided "as-is", without any express or implied warranty. In no event
+
5 * will the authors be held liable for any damages arising from the use of this software.
+
6 *
+
7 * Permission is granted to anyone to use this software for any purpose, including commercial
+
8 * applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
9 *
+
10 * 1. The origin of this software must not be misrepresented; you must not claim that you
+
11 * wrote the original software. If you use this software in a product, an acknowledgment
+
12 * in the product documentation would be appreciated but is not required.
+
13 *
+
14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
+
15 * as being the original software.
+
16 *
+
17 * 3. This notice may not be removed or altered from any source distribution.
+
18 */
+
19
+
20#pragma once
+
21
+
22#define VULK_NO_COPY(ClassName) \
+
23 ClassName(const ClassName&) = delete; \
+
24 ClassName& operator=(const ClassName&) = delete;
+
25
+
26#define VULK_NO_MOVE(ClassName) \
+
27 ClassName(ClassName&&) = delete; \
+
28 ClassName& operator=(ClassName&&) = delete;
+
29
+
30#define VULK_NO_MOVE_OR_COPY(ClassName) \
+
31 VULK_NO_COPY(ClassName) \
+
32 VULK_NO_MOVE(ClassName)
+
33
+
34#define VULK_DEFAULT_COPY(ClassName) \
+
35 ClassName(const ClassName&) = default; \
+
36 ClassName& operator=(const ClassName&) = default;
+
37
+
38#define VULK_DEFAULT_MOVE(ClassName) \
+
39 ClassName(ClassName&&) = default; \
+
40 ClassName& operator=(ClassName&&) = default;
+
41
+
42#define VULK_DEFAULT_MOVE_AND_COPY(ClassName) \
+
43 VULK_DEFAULT_COPY(ClassName) \
+
44 VULK_DEFAULT_MOVE(ClassName)
+
45
+
52template<typename T>
+
53class [[maybe_unused]] TypeChecker;
+
TypeChecker
Definition: ClassUtils.hpp:53
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_context_g_l_f_w_8hpp.html b/docs/html/_context_g_l_f_w_8hpp.html new file mode 100644 index 0000000..d3302e5 --- /dev/null +++ b/docs/html/_context_g_l_f_w_8hpp.html @@ -0,0 +1,73 @@ + + + + + + + +Vulk: lib/include/Vulk/Contexts/ContextGLFW.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Classes | +Namespaces
+
ContextGLFW.hpp File Reference
+
+
+
#include <memory>
+#include "Vulk/ClassUtils.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Classes

class  vulk::ContextGLFW
 
+ + + +

+Namespaces

namespace  vulk
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_context_g_l_f_w_8hpp_source.html b/docs/html/_context_g_l_f_w_8hpp_source.html new file mode 100644 index 0000000..ad16a93 --- /dev/null +++ b/docs/html/_context_g_l_f_w_8hpp_source.html @@ -0,0 +1,105 @@ + + + + + + + +Vulk: lib/include/Vulk/Contexts/ContextGLFW.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
ContextGLFW.hpp
+
+
+Go to the documentation of this file.
1/*
+
2 * Copyright (c) 2021-2021 [fill name later]
+
3 *
+
4 * This software is provided "as-is", without any express or implied warranty. In no event
+
5 * will the authors be held liable for any damages arising from the use of this software.
+
6 *
+
7 * Permission is granted to anyone to use this software for any purpose, including commercial
+
8 * applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
9 *
+
10 * 1. The origin of this software must not be misrepresented; you must not claim that you
+
11 * wrote the original software. If you use this software in a product, an acknowledgment
+
12 * in the product documentation would be appreciated but is not required.
+
13 *
+
14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
+
15 * as being the original software.
+
16 *
+
17 * 3. This notice may not be removed or altered from any source distribution.
+
18 */
+
19
+
20#pragma once
+
21
+
22#include <memory>
+
23
+
24#include "Vulk/ClassUtils.hpp"
+
25
+
26namespace vulk {
+
27class ContextGLFW
+
28{
+
29public:
+
30 ~ContextGLFW();
+
31
+
32 [[nodiscard]] static ContextGLFW& getInstance();
+
33
+
37 inline static void ensureInstance() { (void) getInstance(); }
+
38
+
39 VULK_NO_MOVE_OR_COPY(ContextGLFW)
+
40
+
41private:
+
42 ContextGLFW();
+
43
+
44 static std::unique_ptr<ContextGLFW> s_instance;
+
45};
+
46} // namespace vulk
+ +
VULK_NO_MOVE_OR_COPY
#define VULK_NO_MOVE_OR_COPY(ClassName)
Definition: ClassUtils.hpp:30
+
vulk::ContextGLFW
Definition: ContextGLFW.hpp:28
+
vulk::ContextGLFW::ensureInstance
static void ensureInstance()
Definition: ContextGLFW.hpp:37
+
vulk::ContextGLFW::getInstance
static ContextGLFW & getInstance()
+ +
vulk
Definition: ContextGLFW.hpp:26
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_context_vulkan_8hpp.html b/docs/html/_context_vulkan_8hpp.html new file mode 100644 index 0000000..f8bd84b --- /dev/null +++ b/docs/html/_context_vulkan_8hpp.html @@ -0,0 +1,78 @@ + + + + + + + +Vulk: lib/include/Vulk/Contexts/ContextVulkan.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Classes | +Namespaces
+
ContextVulkan.hpp File Reference
+
+
+
#include <vulkan/vulkan.hpp>
+#include <array>
+#include <memory>
+#include <optional>
+#include "Vulk/ClassUtils.hpp"
+#include "Vulk/Objects.hpp"
+#include "Vulk/Window.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Classes

class  vulk::ContextVulkan
 
+ + + +

+Namespaces

namespace  vulk
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_context_vulkan_8hpp_source.html b/docs/html/_context_vulkan_8hpp_source.html new file mode 100644 index 0000000..6faa010 --- /dev/null +++ b/docs/html/_context_vulkan_8hpp_source.html @@ -0,0 +1,299 @@ + + + + + + + +Vulk: lib/include/Vulk/Contexts/ContextVulkan.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
ContextVulkan.hpp
+
+
+Go to the documentation of this file.
1/*
+
2 * Copyright (c) 2021-2021 [fill name later]
+
3 *
+
4 * This software is provided "as-is", without any express or implied warranty. In no event
+
5 * will the authors be held liable for any damages arising from the use of this software.
+
6 *
+
7 * Permission is granted to anyone to use this software for any purpose, including commercial
+
8 * applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
9 *
+
10 * 1. The origin of this software must not be misrepresented; you must not claim that you
+
11 * wrote the original software. If you use this software in a product, an acknowledgment
+
12 * in the product documentation would be appreciated but is not required.
+
13 *
+
14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
+
15 * as being the original software.
+
16 *
+
17 * 3. This notice may not be removed or altered from any source distribution.
+
18 */
+
19
+
20#pragma once
+
21
+
22#include <vulkan/vulkan.hpp>
+
23
+
24#include <array>
+
25#include <memory>
+
26#include <optional>
+
27
+
28#include "Vulk/ClassUtils.hpp"
+
29#include "Vulk/Objects.hpp"
+
30#include "Vulk/Window.hpp"
+
31
+
32namespace vulk {
+
33class ContextVulkan
+
34{
+
35public:
+
36 ~ContextVulkan();
+
37
+
42 void draw();
+
43
+
44 // TODO: should not be public, remove once events are implemented
+
45 void setFrameBufferResized(bool value) noexcept { m_frameBufferResized = value; }
+
46
+
47 static void createInstance(GLFWwindow* windowHandle);
+
48 static ContextVulkan& getInstance();
+
49
+
50 VULK_NO_MOVE_OR_COPY(ContextVulkan)
+
51
+
52private:
+
53 static void printAvailableValidationLayers();
+
54 static std::vector<const char*> getSupportedValidationLayers();
+
55
+
56 static constexpr std::array VALIDATION_LAYER_NAMES{"VK_LAYER_KHRONOS_validation"};
+
57 static constexpr std::array REQUIRED_EXTENSION_NAMES{VK_KHR_SWAPCHAIN_EXTENSION_NAME};
+
58
+
64 static constexpr std::array PRESENT_MODES_PREFERRED{
+
65 vk::PresentModeKHR::eMailbox, //
+
66 vk::PresentModeKHR::eFifo, //
+
67 vk::PresentModeKHR::eFifoRelaxed, //
+
68 vk::PresentModeKHR::eImmediate, //
+
69
+
70 // vk::PresentModeKHR::eSharedDemandRefresh, //
+
71 // vk::PresentModeKHR::eSharedContinuousRefresh, //
+
72 };
+
73
+
74 struct QueueFamilyIndices
+
75 {
+
76 std::optional<uint32_t> graphicsFamily;
+
77 std::optional<uint32_t> presentFamily;
+
78
+
82 [[nodiscard]] bool isComplete() const noexcept
+
83 {
+
84 return graphicsFamily.has_value() && presentFamily.has_value();
+
85 }
+
86
+
87 // return isComplete() for now, will probably change later
+
91 [[nodiscard]] bool isValid() const noexcept { return isComplete(); }
+
92 };
+
93
+
94 struct SwapChainSupportDetails
+
95 {
+
96 vk::SurfaceCapabilitiesKHR capabilities{};
+
97 std::vector<vk::SurfaceFormatKHR> formats{};
+
98 std::vector<vk::PresentModeKHR> presentModes{};
+
99
+
100 [[nodiscard]] bool isValid() const noexcept { return !formats.empty() && !presentModes.empty(); }
+
101 };
+
102
+
103 struct FrameSyncObjects
+
104 {
+
105 vk::Semaphore imageAvailable{};
+
106 vk::Semaphore renderFinished{};
+
107 vk::Fence fence{};
+
108
+
109 void destroy(vk::Device& device)
+
110 {
+
111 device.destroy(imageAvailable);
+
112 device.destroy(renderFinished);
+
113 device.destroy(fence);
+
114 }
+
115 };
+
116
+
117 using QueueFamilyPropertiesList = std::vector<vk::QueueFamilyProperties>;
+
118 using QueueFamilyEntry = std::pair<QueueFamilyPropertiesList, QueueFamilyIndices>;
+
119
+
120 explicit ContextVulkan(GLFWwindow* windowHandle);
+
121
+
122 void createInstance();
+
123 void createSurface();
+
124 void pickPhysicalDevice();
+
125 void createLogicalDevice();
+
126 void createSwapChain();
+
127 void createImageViews();
+
128 void createRenderPass();
+
129 void createDescriptorSetLayout();
+
130 void createGraphicsPipeline();
+
131 void createFrameBuffers();
+
132 void createCommandPool();
+
133 void createVertexBuffer();
+
134 void createIndexBuffer();
+
135 void createUniformBuffers();
+
136 void createDescriptorPool();
+
137 void createDescriptorSets();
+
138 void createCommandBuffers();
+
139 void createSyncObject();
+
140
+
141 void recordCommandBuffer(vk::CommandBuffer& commandBuffer, uint32_t imageIndex);
+
142
+
143 void recreateSwapChain();
+
144 void createBuffer(vk::DeviceSize size, vk::BufferUsageFlags usage, vk::MemoryPropertyFlags properties,
+
145 vk::Buffer& outBuffer, vk::DeviceMemory& outDeviceMemory);
+
146 void copyBuffer(const vk::Buffer& sourceBuffer, vk::Buffer& destinationBuffer, vk::DeviceSize size);
+
147
+
148 void cleanupSwapchain(vk::SwapchainKHR& swapchain);
+
149 void cleanupSwapchainSubObjects();
+
150
+
151 void chooseSwapSurfaceFormat();
+
152 void chooseSwapPresentMode();
+
153 void chooseSwapExtent();
+
154
+
155 void updateUniformBuffer(uint32_t currentImage);
+
156
+
157 [[nodiscard]] uint32_t findMemoryType(uint32_t typeFilter, vk::MemoryPropertyFlags properties) const;
+
158
+
159 static bool verifyExtensionsSupport(const vk::PhysicalDevice& device);
+
160
+
161 [[nodiscard]] QueueFamilyEntry findQueueFamilies(const vk::PhysicalDevice& physicalDevice) const noexcept;
+
162 [[nodiscard]] SwapChainSupportDetails querySwapChainSupport(const vk::PhysicalDevice& device) const noexcept;
+
163
+
164 // TODO: cache image count used in framebuffers, swap-chain, etc
+
165
+
166 // TODO: the ContextVulkan should not contain the raw window handle, maybe a Window reference though
+
167 GLFWwindow* m_windowHandle;
+
168
+
169 vk::Instance m_instance{};
+
170 vk::PhysicalDevice m_physicalDevice{};
+
171 vk::Device m_device{};
+
172 vk::SurfaceKHR m_surface{};
+
173
+
174 vk::SurfaceFormatKHR m_surfaceFormat{};
+
175 vk::PresentModeKHR m_presentMode{};
+
176 vk::Extent2D m_extent{};
+
177
+
178 vk::Queue m_graphicsQueue{};
+
179 vk::Queue m_presentQueue{};
+
180
+
181 vk::SwapchainKHR m_swapchain{};
+
182 std::vector<vk::Image> m_swapchainImages{};
+
183 std::vector<vk::ImageView> m_swapchainImageViews{};
+
184 vk::Format m_swapchainFormat{};
+
185
+
186 vk::Viewport m_viewport{};
+
187 vk::RenderPass m_renderPass{};
+
188
+
189 vk::DescriptorSetLayout m_descriptorSetLayout{};
+
190 vk::PipelineLayout m_pipelineLayout{};
+
191 vk::Pipeline m_pipeline{};
+
192
+
193 QueueFamilyIndices m_queueFamilyIndices{};
+
194 QueueFamilyPropertiesList m_queueFamilyProperties{};
+
195 SwapChainSupportDetails m_swapchainSupport{};
+
196
+
197 std::vector<vk::Framebuffer> m_swapchainFrameBuffers{};
+
198
+
199 vk::CommandPool m_commandPool{};
+
200 std::vector<vk::CommandBuffer> m_commandBuffers{};
+
201
+
202 std::vector<FrameSyncObjects> m_frameSyncObjects{};
+
203 std::vector<vk::Fence> m_imagesInFlight{};
+
204
+
205 vk::Buffer m_vertexBuffer{};
+
206 vk::DeviceMemory m_vertexBufferMemory{};
+
207 vk::Buffer m_indexBuffer{};
+
208 vk::DeviceMemory m_indexBufferMemory{};
+
209
+
210 std::vector<vk::Buffer> m_uniformBuffers{};
+
211 std::vector<vk::DeviceMemory> m_uniformBuffersMemory{};
+
212
+
213 vk::DescriptorPool m_descriptorPool{};
+
214 std::vector<vk::DescriptorSet> m_descriptorSets{};
+
215
+
216 // TODO: May be better to store in the FrameManager
+
217 size_t m_currentFrame{};
+
218 static const size_t s_maxFramesInFlight;
+
219 //
+
220
+
221 bool m_frameBufferResized{false};
+
222
+
223 template<typename T>
+
224 static constexpr vk::IndexType getIndexType()
+
225 {
+
226 // could be a concept with C++20
+
227 static_assert(std::is_same_v<T, uint16_t> || std::is_same_v<T, uint32_t>);
+
228
+
229 if (std::is_same_v<T, uint16_t>)
+
230 return vk::IndexType::eUint16;
+
231 if (std::is_same_v<T, uint32_t>)
+
232 return vk::IndexType::eUint32;
+
233
+
234 assert(0);
+
235 return vk::IndexType::eNoneKHR;
+
236 }
+
237
+
238 static constexpr auto s_noTimeout = std::numeric_limits<uint64_t>::max();
+
239 static constexpr std::array s_vertices{Vertex{{-0.5f, -0.5f}, {1.0f, 0.0f, 0.0f}}, //
+
240 Vertex{{0.5f, -0.5f}, {0.0f, 1.0f, 0.0f}}, //
+
241 Vertex{{0.5f, 0.5f}, {0.0f, 0.0f, 1.0f}}, //
+
242 Vertex{{-0.5f, 0.5f}, {1.0f, 1.0f, 1.0f}}};
+
243 static constexpr std::array<uint16_t, 6> s_indices{0, 1, 2, 2, 3, 0};
+
244
+
245 static std::unique_ptr<ContextVulkan> s_instance;
+
246};
+
247} // namespace vulk
+ +
VULK_NO_MOVE_OR_COPY
#define VULK_NO_MOVE_OR_COPY(ClassName)
Definition: ClassUtils.hpp:30
+ + +
vulk::ContextVulkan
Definition: ContextVulkan.hpp:34
+
vulk::ContextVulkan::createInstance
static void createInstance(GLFWwindow *windowHandle)
+
vulk::ContextVulkan::getInstance
static ContextVulkan & getInstance()
+ + +
vulk::ContextVulkan::setFrameBufferResized
void setFrameBufferResized(bool value) noexcept
Definition: ContextVulkan.hpp:45
+
vulk
Definition: ContextGLFW.hpp:26
+
Vertex
Definition: Objects.hpp:26
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_exceptions_8hpp.html b/docs/html/_exceptions_8hpp.html new file mode 100644 index 0000000..b37d4ae --- /dev/null +++ b/docs/html/_exceptions_8hpp.html @@ -0,0 +1,140 @@ + + + + + + + +Vulk: lib/include/Vulk/Exceptions.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Classes | +Namespaces | +Macros | +Functions
+
Exceptions.hpp File Reference
+
+
+
#include <vulkan/vulkan.hpp>
+#include <stdexcept>
+#include "Vulk/ClassUtils.hpp"
+
+

Go to the source code of this file.

+ + + + + + + + +

+Classes

class  vulk::Exception
 
class  vulk::GLFWException
 
class  vulk::VulkanException
 
+ + + +

+Namespaces

namespace  vulk
 
+ + + +

+Macros

#define VULK_DEFINE_EXCEPTION(ClassName, OverriddenClassName)
 
+ + + + + + + + + + + +

+Functions

vk::Result vulk::handleVulkanError (vk::Result res)
 
vk::Result vulk::handleVulkanError (VkResult vkRes)
 
template<typename T >
T & vulk::handleVulkanError (vk::ResultValue< T > &res)
 
template<typename T >
const T & vulk::handleVulkanError (const vk::ResultValue< T > &res)
 
+

Macro Definition Documentation

+ +

◆ VULK_DEFINE_EXCEPTION

+ +
+
+ + + + + + + + + + + + + + + + + + +
#define VULK_DEFINE_EXCEPTION( ClassName,
 OverriddenClassName 
)
+
+Value:
class ClassName : public OverriddenClassName \
+
{ \
+
public: \
+
ClassName() : OverriddenClassName{"No additional details provided", #ClassName} {} \
+
explicit ClassName(const char* message, const char* category = #ClassName) \
+
: OverriddenClassName{message, category} \
+
{ \
+
} \
+
explicit ClassName(const std::string& message, const std::string& category = #ClassName) \
+
: OverriddenClassName{message, category} \
+
{ \
+
} \
+
};
+
+
+
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_exceptions_8hpp_source.html b/docs/html/_exceptions_8hpp_source.html new file mode 100644 index 0000000..b325951 --- /dev/null +++ b/docs/html/_exceptions_8hpp_source.html @@ -0,0 +1,194 @@ + + + + + + + +Vulk: lib/include/Vulk/Exceptions.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
Exceptions.hpp
+
+
+Go to the documentation of this file.
1/*
+
2* Copyright (c) 2021-2021 [fill name later]
+
3*
+
4* This software is provided "as-is", without any express or implied warranty. In no event
+
5* will the authors be held liable for any damages arising from the use of this software.
+
6*
+
7* Permission is granted to anyone to use this software for any purpose, including commercial
+
8* applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
9*
+
10* 1. The origin of this software must not be misrepresented; you must not claim that you
+
11* wrote the original software. If you use this software in a product, an acknowledgment
+
12* in the product documentation would be appreciated but is not required.
+
13*
+
14* 2. Altered source versions must be plainly marked as such, and must not be misrepresented
+
15* as being the original software.
+
16*
+
17* 3. This notice may not be removed or altered from any source distribution.
+
18*/
+
19
+
20#pragma once
+
21
+
22#include <vulkan/vulkan.hpp>
+
23
+
24#include <stdexcept>
+
25
+
26#include "Vulk/ClassUtils.hpp"
+
27
+
28namespace vulk {
+
29class Exception : public std::exception
+
30{
+
31public:
+
32 Exception() : Exception{"No additional details provided", "vulk::Exception"} {}
+
33
+
34 explicit Exception(const char* message, const char* category = "vulk::Exception")
+
35 : m_what{std::string{category} + ": " + message}
+
36 {
+
37 }
+
38
+
39 explicit Exception(const std::string& message, const std::string& category = "vulk::Exception")
+
40 : m_what{category + ": " + message}
+
41 {
+
42 }
+
43
+
44 VULK_DEFAULT_MOVE_AND_COPY(Exception)
+
45
+
46 [[nodiscard]] const char* what() const noexcept override { return m_what.c_str(); }
+
47
+
48protected:
+
49 std::string m_what;
+
50};
+
51
+
52#define VULK_DEFINE_EXCEPTION(ClassName, OverriddenClassName) \
+
53 class ClassName : public OverriddenClassName \
+
54 { \
+
55 public: \
+
56 ClassName() : OverriddenClassName{"No additional details provided", #ClassName} {} \
+
57 explicit ClassName(const char* message, const char* category = #ClassName) \
+
58 : OverriddenClassName{message, category} \
+
59 { \
+
60 } \
+
61 explicit ClassName(const std::string& message, const std::string& category = #ClassName) \
+
62 : OverriddenClassName{message, category} \
+
63 { \
+
64 } \
+
65 };
+
66
+
67VULK_DEFINE_EXCEPTION(IOException, Exception)
+
68VULK_DEFINE_EXCEPTION(FileNotFoundException, IOException)
+
69VULK_DEFINE_EXCEPTION(PermissionDeniedException, IOException)
+
70
+
71VULK_DEFINE_EXCEPTION(LibraryException, Exception)
+
72
+
73class GLFWException : public LibraryException
+
74{
+
75public:
+
76 explicit GLFWException(const std::string& message = getGLFWError()) : LibraryException(message, "GLFWException") {}
+
77
+
78 static std::string getGLFWError() noexcept;
+
79};
+
80
+
81class VulkanException : public LibraryException
+
82{
+
83public:
+
84 explicit VulkanException(vk::Result result);
+
85 explicit VulkanException(const char* what);
+
86 explicit VulkanException(const std::string& what);
+
87};
+
88
+
89inline vk::Result handleVulkanError(vk::Result res)
+
90{
+
91 if (res != vk::Result::eSuccess)
+
92 throw VulkanException(res);
+
93 return res;
+
94}
+
95
+
96inline vk::Result handleVulkanError(VkResult vkRes)
+
97{
+
98 auto res = static_cast<vk::Result>(vkRes);
+
99
+
100 if (res != vk::Result::eSuccess)
+
101 throw VulkanException(res);
+
102 return res;
+
103}
+
104
+
105template<typename T>
+
106inline T& handleVulkanError(vk::ResultValue<T>& res)
+
107{
+
108 if (res.result != vk::Result::eSuccess)
+
109 throw VulkanException(res.result);
+
110 return res.value;
+
111}
+
112
+
113template<typename T>
+
114inline const T& handleVulkanError(const vk::ResultValue<T>& res)
+
115{
+
116 if (res.result != vk::Result::eSuccess)
+
117 throw VulkanException(res.result);
+
118 return res.value;
+
119}
+
120} // namespace vulk
+ +
VULK_DEFAULT_MOVE_AND_COPY
#define VULK_DEFAULT_MOVE_AND_COPY(ClassName)
Definition: ClassUtils.hpp:42
+
VULK_DEFINE_EXCEPTION
#define VULK_DEFINE_EXCEPTION(ClassName, OverriddenClassName)
Definition: Exceptions.hpp:52
+
vulk::Exception
Definition: Exceptions.hpp:30
+
vulk::Exception::Exception
Exception()
Definition: Exceptions.hpp:32
+
vulk::Exception::what
const char * what() const noexcept override
Definition: Exceptions.hpp:46
+
vulk::Exception::Exception
Exception(const char *message, const char *category="vulk::Exception")
Definition: Exceptions.hpp:34
+
vulk::Exception::m_what
std::string m_what
Definition: Exceptions.hpp:49
+
vulk::Exception::Exception
Exception(const std::string &message, const std::string &category="vulk::Exception")
Definition: Exceptions.hpp:39
+
vulk::GLFWException
Definition: Exceptions.hpp:74
+
vulk::GLFWException::GLFWException
GLFWException(const std::string &message=getGLFWError())
Definition: Exceptions.hpp:76
+
vulk::GLFWException::getGLFWError
static std::string getGLFWError() noexcept
+
vulk::VulkanException
Definition: Exceptions.hpp:82
+
vulk::VulkanException::VulkanException
VulkanException(const std::string &what)
+
vulk::VulkanException::VulkanException
VulkanException(const char *what)
+
vulk::VulkanException::VulkanException
VulkanException(vk::Result result)
+
vulk
Definition: ContextGLFW.hpp:26
+
vulk::handleVulkanError
vk::Result handleVulkanError(vk::Result res)
Definition: Exceptions.hpp:89
+ +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_frame_manager_8hpp.html b/docs/html/_frame_manager_8hpp.html new file mode 100644 index 0000000..fb1f23f --- /dev/null +++ b/docs/html/_frame_manager_8hpp.html @@ -0,0 +1,112 @@ + + + + + + + +Vulk: lib/include/Vulk/FrameManager.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Classes | +Namespaces | +Functions
+
FrameManager.hpp File Reference
+
+
+
#include <array>
+#include <chrono>
+#include <functional>
+#include <optional>
+#include <string>
+#include "Time.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Classes

class  vulk::FrameManager
 
+ + + +

+Namespaces

namespace  vulk
 
+ + + +

+Functions

std::ostream & operator<< (std::ostream &os, const vulk::FrameManager &frameManager)
 
+

Function Documentation

+ +

◆ operator<<()

+ +
+
+ + + + + + + + + + + + + + + + + + +
std::ostream & operator<< (std::ostream & os,
const vulk::FrameManager & frameManager 
)
+
+ +
+
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_frame_manager_8hpp_source.html b/docs/html/_frame_manager_8hpp_source.html new file mode 100644 index 0000000..e6d727d --- /dev/null +++ b/docs/html/_frame_manager_8hpp_source.html @@ -0,0 +1,131 @@ + + + + + + + +Vulk: lib/include/Vulk/FrameManager.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
FrameManager.hpp
+
+
+Go to the documentation of this file.
1/*
+
2 * Copyright (c) 2021-2021 [fill name later]
+
3 *
+
4 * This software is provided "as-is", without any express or implied warranty. In no event
+
5 * will the authors be held liable for any damages arising from the use of this software.
+
6 *
+
7 * Permission is granted to anyone to use this software for any purpose, including commercial
+
8 * applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
9 *
+
10 * 1. The origin of this software must not be misrepresented; you must not claim that you
+
11 * wrote the original software. If you use this software in a product, an acknowledgment
+
12 * in the product documentation would be appreciated but is not required.
+
13 *
+
14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
+
15 * as being the original software.
+
16 *
+
17 * 3. This notice may not be removed or altered from any source distribution.
+
18 */
+
19
+
20#pragma once
+
21
+
22#include <array>
+
23#include <chrono>
+
24#include <functional>
+
25#include <optional>
+
26#include <string>
+
27
+
28#include "Time.hpp"
+
29
+
30namespace vulk {
+
31class FrameManager final
+
32{
+
33public:
+
34 using OnSecondCallback = std::function<void(const FrameManager& frameManager)>;
+
35 using FramerateStringBuffer = std::array<char, 16>;
+
36
+
37 FrameManager();
+
38
+
39 void update() noexcept;
+
40
+
41 void setOnSecondCallback(const OnSecondCallback& func) noexcept { m_onSecondCallback = func; }
+
42
+
43 [[nodiscard]] auto getDeltaTime() const noexcept { return m_deltaTime; }
+
44 [[nodiscard]] auto getFPS() const noexcept { return m_framerate; }
+
45 [[nodiscard]] FramerateStringBuffer getFramerateCString() const noexcept;
+
46 [[nodiscard]] std::string getFramerateString() const noexcept;
+
47
+
48private:
+
49 Duration m_duration{};
+
50 TimePoint m_lastFrame{};
+
51 TimePoint m_lastSecond{};
+
52
+
53 float m_deltaTime{};
+
54 uint32_t m_framerate{};
+
55 uint32_t m_frameCounter{};
+
56
+
57 std::optional<OnSecondCallback> m_onSecondCallback{std::nullopt};
+
58};
+
59} // namespace vulk
+
60
+
61std::ostream& operator<<(std::ostream& os, const vulk::FrameManager& frameManager);
+
operator<<
std::ostream & operator<<(std::ostream &os, const vulk::FrameManager &frameManager)
+ +
vulk::FrameManager
Definition: FrameManager.hpp:32
+
vulk::FrameManager::update
void update() noexcept
+
vulk::FrameManager::OnSecondCallback
std::function< void(const FrameManager &frameManager)> OnSecondCallback
Definition: FrameManager.hpp:34
+
vulk::FrameManager::getFPS
auto getFPS() const noexcept
Definition: FrameManager.hpp:44
+
vulk::FrameManager::getFramerateCString
FramerateStringBuffer getFramerateCString() const noexcept
+
vulk::FrameManager::getDeltaTime
auto getDeltaTime() const noexcept
Definition: FrameManager.hpp:43
+
vulk::FrameManager::setOnSecondCallback
void setOnSecondCallback(const OnSecondCallback &func) noexcept
Definition: FrameManager.hpp:41
+
vulk::FrameManager::FramerateStringBuffer
std::array< char, 16 > FramerateStringBuffer
Definition: FrameManager.hpp:35
+
vulk::FrameManager::getFramerateString
std::string getFramerateString() const noexcept
+ +
vulk
Definition: ContextGLFW.hpp:26
+
vulk::TimePoint
decltype(Clock::now()) TimePoint
Definition: Time.hpp:27
+
vulk::Duration
std::chrono::duration< float > Duration
Definition: Time.hpp:26
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_keyboard_8hpp.html b/docs/html/_keyboard_8hpp.html new file mode 100644 index 0000000..fb79d08 --- /dev/null +++ b/docs/html/_keyboard_8hpp.html @@ -0,0 +1,233 @@ + + + + + + + +Vulk: lib/include/Vulk/Keyboard.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Classes | +Namespaces | +Enumerations
+
Keyboard.hpp File Reference
+
+
+
#include <GLFW/glfw3.h>
+#include <array>
+#include <functional>
+
+

Go to the source code of this file.

+ + + + +

+Classes

class  vulk::Keyboard
 
+ + + +

+Namespaces

namespace  vulk
 
+ + + +

+Enumerations

enum class  vulk::Key {
+  vulk::UNKNOWN = GLFW_KEY_UNKNOWN +, vulk::SPACE = GLFW_KEY_SPACE +, vulk::APOSTROPHE = GLFW_KEY_APOSTROPHE +, vulk::COMMA = GLFW_KEY_COMMA +,
+  vulk::MINUS = GLFW_KEY_MINUS +, vulk::PERIOD = GLFW_KEY_PERIOD +, vulk::SLASH = GLFW_KEY_SLASH +, vulk::NUM_0 = GLFW_KEY_0 +,
+  vulk::NUM_1 = GLFW_KEY_1 +, vulk::NUM_2 = GLFW_KEY_2 +, vulk::NUM_3 = GLFW_KEY_3 +, vulk::NUM_4 = GLFW_KEY_4 +,
+  vulk::NUM_5 = GLFW_KEY_5 +, vulk::NUM_6 = GLFW_KEY_6 +, vulk::NUM_7 = GLFW_KEY_7 +, vulk::NUM_8 = GLFW_KEY_8 +,
+  vulk::NUM_9 = GLFW_KEY_9 +, vulk::SEMICOLON = GLFW_KEY_SEMICOLON +, vulk::EQUAL = GLFW_KEY_EQUAL +, vulk::A = GLFW_KEY_A +,
+  vulk::B = GLFW_KEY_B +, vulk::C = GLFW_KEY_C +, vulk::D = GLFW_KEY_D +, vulk::E = GLFW_KEY_E +,
+  vulk::F = GLFW_KEY_F +, vulk::G = GLFW_KEY_G +, vulk::H = GLFW_KEY_H +, vulk::I = GLFW_KEY_I +,
+  vulk::J = GLFW_KEY_J +, vulk::K = GLFW_KEY_K +, vulk::L = GLFW_KEY_L +, vulk::M = GLFW_KEY_M +,
+  vulk::N = GLFW_KEY_N +, vulk::O = GLFW_KEY_O +, vulk::P = GLFW_KEY_P +, vulk::Q = GLFW_KEY_Q +,
+  vulk::R = GLFW_KEY_R +, vulk::S = GLFW_KEY_S +, vulk::T = GLFW_KEY_T +, vulk::U = GLFW_KEY_U +,
+  vulk::V = GLFW_KEY_V +, vulk::W = GLFW_KEY_W +, vulk::X = GLFW_KEY_X +, vulk::Y = GLFW_KEY_Y +,
+  vulk::Z = GLFW_KEY_Z +, vulk::LEFT_BRACKET = GLFW_KEY_LEFT_BRACKET +, vulk::BACKSLASH = GLFW_KEY_BACKSLASH +, vulk::RIGHT_BRACKET = GLFW_KEY_RIGHT_BRACKET +,
+  vulk::GRAVE_ACCENT = GLFW_KEY_GRAVE_ACCENT +, vulk::WORLD_1 = GLFW_KEY_WORLD_1 +, vulk::WORLD_2 = GLFW_KEY_WORLD_2 +, vulk::ESCAPE = GLFW_KEY_ESCAPE +,
+  vulk::ENTER = GLFW_KEY_ENTER +, vulk::TAB = GLFW_KEY_TAB +, vulk::BACKSPACE = GLFW_KEY_BACKSPACE +, vulk::INSERT = GLFW_KEY_INSERT +,
+  vulk::KEY_DELETE = GLFW_KEY_DELETE +, vulk::RIGHT = GLFW_KEY_RIGHT +, vulk::LEFT = GLFW_KEY_LEFT +, vulk::DOWN = GLFW_KEY_DOWN +,
+  vulk::UP = GLFW_KEY_UP +, vulk::PAGE_UP = GLFW_KEY_PAGE_UP +, vulk::PAGE_DOWN = GLFW_KEY_PAGE_DOWN +, vulk::HOME = GLFW_KEY_HOME +,
+  vulk::END = GLFW_KEY_END +, vulk::CAPS_LOCK = GLFW_KEY_CAPS_LOCK +, vulk::SCROLL_LOCK = GLFW_KEY_SCROLL_LOCK +, vulk::NUM_LOCK = GLFW_KEY_NUM_LOCK +,
+  vulk::PRINT_SCREEN = GLFW_KEY_PRINT_SCREEN +, vulk::PAUSE = GLFW_KEY_PAUSE +, vulk::F1 = GLFW_KEY_F1 +, vulk::F2 = GLFW_KEY_F2 +,
+  vulk::F3 = GLFW_KEY_F3 +, vulk::F4 = GLFW_KEY_F4 +, vulk::F5 = GLFW_KEY_F5 +, vulk::F6 = GLFW_KEY_F6 +,
+  vulk::F7 = GLFW_KEY_F7 +, vulk::F8 = GLFW_KEY_F8 +, vulk::F9 = GLFW_KEY_F9 +, vulk::F10 = GLFW_KEY_F10 +,
+  vulk::F11 = GLFW_KEY_F11 +, vulk::F12 = GLFW_KEY_F12 +, vulk::F13 = GLFW_KEY_F13 +, vulk::F14 = GLFW_KEY_F14 +,
+  vulk::F15 = GLFW_KEY_F15 +, vulk::F16 = GLFW_KEY_F16 +, vulk::F17 = GLFW_KEY_F17 +, vulk::F18 = GLFW_KEY_F18 +,
+  vulk::F19 = GLFW_KEY_F19 +, vulk::F20 = GLFW_KEY_F20 +, vulk::F21 = GLFW_KEY_F21 +, vulk::F22 = GLFW_KEY_F22 +,
+  vulk::F23 = GLFW_KEY_F23 +, vulk::F24 = GLFW_KEY_F24 +, vulk::F25 = GLFW_KEY_F25 +, vulk::KP_0 = GLFW_KEY_KP_0 +,
+  vulk::KP_1 = GLFW_KEY_KP_1 +, vulk::KP_2 = GLFW_KEY_KP_2 +, vulk::KP_3 = GLFW_KEY_KP_3 +, vulk::KP_4 = GLFW_KEY_KP_4 +,
+  vulk::KP_5 = GLFW_KEY_KP_5 +, vulk::KP_6 = GLFW_KEY_KP_6 +, vulk::KP_7 = GLFW_KEY_KP_7 +, vulk::KP_8 = GLFW_KEY_KP_8 +,
+  vulk::KP_9 = GLFW_KEY_KP_9 +, vulk::KP_DECIMAL = GLFW_KEY_KP_DECIMAL +, vulk::KP_DIVIDE = GLFW_KEY_KP_DIVIDE +, vulk::KP_MULTIPLY = GLFW_KEY_KP_MULTIPLY +,
+  vulk::KP_SUBTRACT = GLFW_KEY_KP_SUBTRACT +, vulk::KP_ADD = GLFW_KEY_KP_ADD +, vulk::KP_ENTER = GLFW_KEY_KP_ENTER +, vulk::KP_EQUAL = GLFW_KEY_KP_EQUAL +,
+  vulk::LEFT_SHIFT = GLFW_KEY_LEFT_SHIFT +, vulk::LEFT_CONTROL = GLFW_KEY_LEFT_CONTROL +, vulk::LEFT_ALT = GLFW_KEY_LEFT_ALT +, vulk::LEFT_SUPER = GLFW_KEY_LEFT_SUPER +,
+  vulk::RIGHT_SHIFT = GLFW_KEY_RIGHT_SHIFT +, vulk::RIGHT_CONTROL = GLFW_KEY_RIGHT_CONTROL +, vulk::RIGHT_ALT = GLFW_KEY_RIGHT_ALT +, vulk::RIGHT_SUPER = GLFW_KEY_RIGHT_SUPER +,
+  vulk::MENU = GLFW_KEY_MENU +
+ }
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_keyboard_8hpp_source.html b/docs/html/_keyboard_8hpp_source.html new file mode 100644 index 0000000..464ed5e --- /dev/null +++ b/docs/html/_keyboard_8hpp_source.html @@ -0,0 +1,358 @@ + + + + + + + +Vulk: lib/include/Vulk/Keyboard.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
Keyboard.hpp
+
+
+Go to the documentation of this file.
1/*
+
2 * Copyright (c) 2021-2021 [fill name later]
+
3 *
+
4 * This software is provided "as-is", without any express or implied warranty. In no event
+
5 * will the authors be held liable for any damages arising from the use of this software.
+
6 *
+
7 * Permission is granted to anyone to use this software for any purpose, including commercial
+
8 * applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
9 *
+
10 * 1. The origin of this software must not be misrepresented; you must not claim that you
+
11 * wrote the original software. If you use this software in a product, an acknowledgment
+
12 * in the product documentation would be appreciated but is not required.
+
13 *
+
14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
+
15 * as being the original software.
+
16 *
+
17 * 3. This notice may not be removed or altered from any source distribution.
+
18 */
+
19
+
20#pragma once
+
21
+
22#include <GLFW/glfw3.h>
+
23
+
24#include <array>
+
25#include <functional>
+
26
+
27namespace vulk {
+
28
+
29enum class Key
+
30{
+
31 UNKNOWN = GLFW_KEY_UNKNOWN,
+
32
+
33 /* Printable keys */
+
34 SPACE = GLFW_KEY_SPACE,
+
35 APOSTROPHE = GLFW_KEY_APOSTROPHE,
+
36 COMMA = GLFW_KEY_COMMA,
+
37 MINUS = GLFW_KEY_MINUS,
+
38 PERIOD = GLFW_KEY_PERIOD,
+
39 SLASH = GLFW_KEY_SLASH,
+
40 NUM_0 = GLFW_KEY_0,
+
41 NUM_1 = GLFW_KEY_1,
+
42 NUM_2 = GLFW_KEY_2,
+
43 NUM_3 = GLFW_KEY_3,
+
44 NUM_4 = GLFW_KEY_4,
+
45 NUM_5 = GLFW_KEY_5,
+
46 NUM_6 = GLFW_KEY_6,
+
47 NUM_7 = GLFW_KEY_7,
+
48 NUM_8 = GLFW_KEY_8,
+
49 NUM_9 = GLFW_KEY_9,
+
50 SEMICOLON = GLFW_KEY_SEMICOLON,
+
51 EQUAL = GLFW_KEY_EQUAL,
+
52 A = GLFW_KEY_A,
+
53 B = GLFW_KEY_B,
+
54 C = GLFW_KEY_C,
+
55 D = GLFW_KEY_D,
+
56 E = GLFW_KEY_E,
+
57 F = GLFW_KEY_F,
+
58 G = GLFW_KEY_G,
+
59 H = GLFW_KEY_H,
+
60 I = GLFW_KEY_I,
+
61 J = GLFW_KEY_J,
+
62 K = GLFW_KEY_K,
+
63 L = GLFW_KEY_L,
+
64 M = GLFW_KEY_M,
+
65 N = GLFW_KEY_N,
+
66 O = GLFW_KEY_O,
+
67 P = GLFW_KEY_P,
+
68 Q = GLFW_KEY_Q,
+
69 R = GLFW_KEY_R,
+
70 S = GLFW_KEY_S,
+
71 T = GLFW_KEY_T,
+
72 U = GLFW_KEY_U,
+
73 V = GLFW_KEY_V,
+
74 W = GLFW_KEY_W,
+
75 X = GLFW_KEY_X,
+
76 Y = GLFW_KEY_Y,
+
77 Z = GLFW_KEY_Z,
+
78 LEFT_BRACKET = GLFW_KEY_LEFT_BRACKET,
+
79 BACKSLASH = GLFW_KEY_BACKSLASH,
+
80 RIGHT_BRACKET = GLFW_KEY_RIGHT_BRACKET,
+
81 GRAVE_ACCENT = GLFW_KEY_GRAVE_ACCENT,
+
82 WORLD_1 = GLFW_KEY_WORLD_1,
+
83 WORLD_2 = GLFW_KEY_WORLD_2,
+
84
+
85 /* Function keys */
+
86 ESCAPE = GLFW_KEY_ESCAPE,
+
87 ENTER = GLFW_KEY_ENTER,
+
88 TAB = GLFW_KEY_TAB,
+
89 BACKSPACE = GLFW_KEY_BACKSPACE,
+
90 INSERT = GLFW_KEY_INSERT,
+
91 KEY_DELETE = GLFW_KEY_DELETE,
+
92 RIGHT = GLFW_KEY_RIGHT,
+
93 LEFT = GLFW_KEY_LEFT,
+
94 DOWN = GLFW_KEY_DOWN,
+
95 UP = GLFW_KEY_UP,
+
96 PAGE_UP = GLFW_KEY_PAGE_UP,
+
97 PAGE_DOWN = GLFW_KEY_PAGE_DOWN,
+
98 HOME = GLFW_KEY_HOME,
+
99 END = GLFW_KEY_END,
+
100 CAPS_LOCK = GLFW_KEY_CAPS_LOCK,
+
101 SCROLL_LOCK = GLFW_KEY_SCROLL_LOCK,
+
102 NUM_LOCK = GLFW_KEY_NUM_LOCK,
+
103 PRINT_SCREEN = GLFW_KEY_PRINT_SCREEN,
+
104 PAUSE = GLFW_KEY_PAUSE,
+
105 F1 = GLFW_KEY_F1,
+
106 F2 = GLFW_KEY_F2,
+
107 F3 = GLFW_KEY_F3,
+
108 F4 = GLFW_KEY_F4,
+
109 F5 = GLFW_KEY_F5,
+
110 F6 = GLFW_KEY_F6,
+
111 F7 = GLFW_KEY_F7,
+
112 F8 = GLFW_KEY_F8,
+
113 F9 = GLFW_KEY_F9,
+
114 F10 = GLFW_KEY_F10,
+
115 F11 = GLFW_KEY_F11,
+
116 F12 = GLFW_KEY_F12,
+
117 F13 = GLFW_KEY_F13,
+
118 F14 = GLFW_KEY_F14,
+
119 F15 = GLFW_KEY_F15,
+
120 F16 = GLFW_KEY_F16,
+
121 F17 = GLFW_KEY_F17,
+
122 F18 = GLFW_KEY_F18,
+
123 F19 = GLFW_KEY_F19,
+
124 F20 = GLFW_KEY_F20,
+
125 F21 = GLFW_KEY_F21,
+
126 F22 = GLFW_KEY_F22,
+
127 F23 = GLFW_KEY_F23,
+
128 F24 = GLFW_KEY_F24,
+
129 F25 = GLFW_KEY_F25,
+
130 KP_0 = GLFW_KEY_KP_0,
+
131 KP_1 = GLFW_KEY_KP_1,
+
132 KP_2 = GLFW_KEY_KP_2,
+
133 KP_3 = GLFW_KEY_KP_3,
+
134 KP_4 = GLFW_KEY_KP_4,
+
135 KP_5 = GLFW_KEY_KP_5,
+
136 KP_6 = GLFW_KEY_KP_6,
+
137 KP_7 = GLFW_KEY_KP_7,
+
138 KP_8 = GLFW_KEY_KP_8,
+
139 KP_9 = GLFW_KEY_KP_9,
+
140 KP_DECIMAL = GLFW_KEY_KP_DECIMAL,
+
141 KP_DIVIDE = GLFW_KEY_KP_DIVIDE,
+
142 KP_MULTIPLY = GLFW_KEY_KP_MULTIPLY,
+
143 KP_SUBTRACT = GLFW_KEY_KP_SUBTRACT,
+
144 KP_ADD = GLFW_KEY_KP_ADD,
+
145 KP_ENTER = GLFW_KEY_KP_ENTER,
+
146 KP_EQUAL = GLFW_KEY_KP_EQUAL,
+
147 LEFT_SHIFT = GLFW_KEY_LEFT_SHIFT,
+
148 LEFT_CONTROL = GLFW_KEY_LEFT_CONTROL,
+
149 LEFT_ALT = GLFW_KEY_LEFT_ALT,
+
150 LEFT_SUPER = GLFW_KEY_LEFT_SUPER,
+
151 RIGHT_SHIFT = GLFW_KEY_RIGHT_SHIFT,
+
152 RIGHT_CONTROL = GLFW_KEY_RIGHT_CONTROL,
+
153 RIGHT_ALT = GLFW_KEY_RIGHT_ALT,
+
154 RIGHT_SUPER = GLFW_KEY_RIGHT_SUPER,
+
155 MENU = GLFW_KEY_MENU,
+
156};
+
157
+
158class Keyboard final
+
159{
+
160public:
+
161 explicit Keyboard(GLFWwindow* window);
+
162 ~Keyboard();
+
163
+
164 inline bool isKeyDown(vulk::Key key) const noexcept { return m_keyboardInputs[static_cast<size_t>(key)]; };
+
165
+
166 void onKeyPressed(int scancode, int action);
+
167
+
168 [[nodiscard]] inline static Keyboard* getKeyboard(GLFWwindow* window) { return s_linkedKeyboard[window]; }
+
169
+
170private:
+
171 static std::unordered_map<GLFWwindow*, Keyboard*> s_linkedKeyboard;
+
172 std::array<bool, GLFW_KEY_LAST + 1> m_keyboardInputs{};
+
173};
+
174} // namespace vulk
+
vulk::Keyboard
Definition: Keyboard.hpp:159
+
vulk::Keyboard::Keyboard
Keyboard(GLFWwindow *window)
+
vulk::Keyboard::getKeyboard
static Keyboard * getKeyboard(GLFWwindow *window)
Definition: Keyboard.hpp:168
+ +
vulk::Keyboard::onKeyPressed
void onKeyPressed(int scancode, int action)
+
vulk::Keyboard::isKeyDown
bool isKeyDown(vulk::Key key) const noexcept
Definition: Keyboard.hpp:164
+
vulk
Definition: ContextGLFW.hpp:26
+
vulk::Key
Key
Definition: Keyboard.hpp:30
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_mat3_8hpp.html b/docs/html/_mat3_8hpp.html new file mode 100644 index 0000000..50bd6f3 --- /dev/null +++ b/docs/html/_mat3_8hpp.html @@ -0,0 +1,76 @@ + + + + + + + +Vulk: lib/include/Vulk/Mat3.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Classes | +Namespaces
+
Mat3.hpp File Reference
+
+
+
#include <glm/glm.hpp>
+#include <glm/gtx/string_cast.hpp>
+#include <array>
+#include <cmath>
+#include <iostream>
+
+

Go to the source code of this file.

+ + + + +

+Classes

struct  vulk::Mat3< T >
 
+ + + +

+Namespaces

namespace  vulk
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_mat3_8hpp_source.html b/docs/html/_mat3_8hpp_source.html new file mode 100644 index 0000000..ac3f3e3 --- /dev/null +++ b/docs/html/_mat3_8hpp_source.html @@ -0,0 +1,144 @@ + + + + + + + +Vulk: lib/include/Vulk/Mat3.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
Mat3.hpp
+
+
+Go to the documentation of this file.
1/*
+
2 * Copyright (c) 2021-2021 [fill name later]
+
3 *
+
4 * This software is provided "as-is", without any express or implied warranty. In no event
+
5 * will the authors be held liable for any damages arising from the use of this software.
+
6 *
+
7 * Permission is granted to anyone to use this software for any purpose, including commercial
+
8 * applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
9 *
+
10 * 1. The origin of this software must not be misrepresented; you must not claim that you
+
11 * wrote the original software. If you use this software in a product, an acknowledgment
+
12 * in the product documentation would be appreciated but is not required.
+
13 *
+
14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
+
15 * as being the original software.
+
16 *
+
17 * 3. This notice may not be removed or altered from any source distribution.
+
18 */
+
19
+
20#pragma once
+
21
+
22#include <glm/glm.hpp>
+
23#include <glm/gtx/string_cast.hpp>
+
24
+
25#include <array>
+
26#include <cmath>
+
27#include <iostream>
+
28
+
29namespace vulk {
+
30template<typename T>
+
31struct Mat3
+
32{
+
33 std::array<T, 9> m{
+
34 1.0, 0.0, 0.0, // a b c
+
35 0.0, 1.0, 0.0, // d e f
+
36 0.0, 0.0, 1.0 // g h i
+
37 };
+
38
+
39 constexpr Mat3() = default;
+
40 constexpr explicit Mat3(T value) : m{std::array<T, 9>{value, 0.0, 0.0, 0.0, value, 0.0, 0.0, 0.0, value}} {}
+
41 constexpr explicit Mat3(const std::array<T, 9> mat) : m{mat} {}
+
42 constexpr Mat3(T a1, T a2, T a3, T a4, T a5, T a6, T a7, T a8, T a9)
+
43 : m{std::array<T, 9>{a1, a2, a3, a4, a5, a6, a7, a8, a9}}
+
44 {
+
45 }
+
46
+
47 constexpr Mat3 inverse() const noexcept
+
48 {
+
49 auto cfMatrix = coFactor();
+
50 auto d = determinant();
+
51
+
52 return Mat3{cfMatrix.m[0] / d, cfMatrix.m[1] / d, cfMatrix.m[2] / d, cfMatrix.m[3] / d, cfMatrix.m[4] / d,
+
53 cfMatrix.m[5] / d, cfMatrix.m[6] / d, cfMatrix.m[7] / d, cfMatrix.m[8] / d};
+
54 }
+
55
+
56 constexpr Mat3 coFactor() const noexcept
+
57 {
+
58 return Mat3{
+
59 ((m[4] * m[8]) - (m[5] * m[7])), -((m[3] * m[8]) - (m[5] * m[6])), ((m[3] * m[7]) - (m[4] * m[6])),
+
60 -((m[1] * m[8]) - (m[2] * m[7])), ((m[0] * m[8]) - (m[2] * m[6])), -((m[0] * m[7]) - (m[1] * m[6])),
+
61 ((m[1] * m[5]) - (m[2] * m[4])), -((m[0] * m[5]) - (m[2] * m[3])), ((m[0] * m[4]) - (m[1] * m[3]))};
+
62 }
+
63
+
64 constexpr T determinant() const noexcept
+
65 {
+
66 auto cfMatrix = coFactor();
+
67 return ((m[0] * cfMatrix.m[0]) + (m[1] * cfMatrix.m[1]) + (m[2] * cfMatrix.m[2]));
+
68 }
+
69
+
70 constexpr friend std::ostream& operator<<(std::ostream& os, const Mat3& mat3) noexcept
+
71 {
+
72 return os << mat3.m[0] << ' ' << mat3.m[1] << ' ' << mat3.m[2] << '\n'
+
73 << mat3.m[3] << ' ' << mat3.m[4] << ' ' << mat3.m[5] << '\n'
+
74 << mat3.m[6] << ' ' << mat3.m[7] << ' ' << mat3.m[8];
+
75 }
+
76};
+
77} // namespace vulk
+
vulk
Definition: ContextGLFW.hpp:26
+ +
vulk::Mat3
Definition: Mat3.hpp:32
+
vulk::Mat3::coFactor
constexpr Mat3 coFactor() const noexcept
Definition: Mat3.hpp:56
+
vulk::Mat3::determinant
constexpr T determinant() const noexcept
Definition: Mat3.hpp:64
+
vulk::Mat3::Mat3
constexpr Mat3()=default
+
vulk::Mat3::inverse
constexpr Mat3 inverse() const noexcept
Definition: Mat3.hpp:47
+
vulk::Mat3::operator<<
constexpr friend std::ostream & operator<<(std::ostream &os, const Mat3 &mat3) noexcept
Definition: Mat3.hpp:70
+
vulk::Mat3::Mat3
constexpr Mat3(const std::array< T, 9 > mat)
Definition: Mat3.hpp:41
+
vulk::Mat3::m
std::array< T, 9 > m
Definition: Mat3.hpp:33
+
vulk::Mat3::Mat3
constexpr Mat3(T a1, T a2, T a3, T a4, T a5, T a6, T a7, T a8, T a9)
Definition: Mat3.hpp:42
+
vulk::Mat3::Mat3
constexpr Mat3(T value)
Definition: Mat3.hpp:40
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_mouse_8hpp.html b/docs/html/_mouse_8hpp.html new file mode 100644 index 0000000..930a69a --- /dev/null +++ b/docs/html/_mouse_8hpp.html @@ -0,0 +1,96 @@ + + + + + + + +Vulk: lib/include/Vulk/Mouse.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Classes | +Namespaces | +Enumerations
+
Mouse.hpp File Reference
+
+
+
#include <GLFW/glfw3.h>
+#include <array>
+#include <functional>
+
+

Go to the source code of this file.

+ + + + +

+Classes

class  vulk::Mouse
 
+ + + +

+Namespaces

namespace  vulk
 
+ + + +

+Enumerations

enum class  vulk::Buttons {
+  vulk::BUTTON_1 = GLFW_MOUSE_BUTTON_1 +, vulk::BUTTON_2 = GLFW_MOUSE_BUTTON_2 +, vulk::BUTTON_3 = GLFW_MOUSE_BUTTON_3 +, vulk::BUTTON_4 = GLFW_MOUSE_BUTTON_4 +,
+  vulk::BUTTON_5 = GLFW_MOUSE_BUTTON_5 +, vulk::BUTTON_6 = GLFW_MOUSE_BUTTON_6 +, vulk::BUTTON_7 = GLFW_MOUSE_BUTTON_7 +, vulk::BUTTON_8 = GLFW_MOUSE_BUTTON_8 +,
+  vulk::BUTTON_LEFT = GLFW_MOUSE_BUTTON_LEFT +, vulk::BUTTON_RIGHT = GLFW_MOUSE_BUTTON_RIGHT +, vulk::BUTTON_MIDDLE = GLFW_MOUSE_BUTTON_MIDDLE +, vulk::BUTTON_LAST = GLFW_MOUSE_BUTTON_LAST +
+ }
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_mouse_8hpp_source.html b/docs/html/_mouse_8hpp_source.html new file mode 100644 index 0000000..b9af2ea --- /dev/null +++ b/docs/html/_mouse_8hpp_source.html @@ -0,0 +1,136 @@ + + + + + + + +Vulk: lib/include/Vulk/Mouse.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
Mouse.hpp
+
+
+Go to the documentation of this file.
1/*
+
2 * Copyright (c) 2021-2021 [fill name later]
+
3 *
+
4 * This software is provided "as-is", without any express or implied warranty. In no event
+
5 * will the authors be held liable for any damages arising from the use of this software.
+
6 *
+
7 * Permission is granted to anyone to use this software for any purpose, including commercial
+
8 * applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
9 *
+
10 * 1. The origin of this software must not be misrepresented; you must not claim that you
+
11 * wrote the original software. If you use this software in a product, an acknowledgment
+
12 * in the product documentation would be appreciated but is not required.
+
13 *
+
14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
+
15 * as being the original software.
+
16 *
+
17 * 3. This notice may not be removed or altered from any source distribution.
+
18 */
+
19
+
20#pragma once
+
21
+
22#include <GLFW/glfw3.h>
+
23
+
24#include <array>
+
25#include <functional>
+
26
+
27namespace vulk {
+
28
+
29enum class Buttons
+
30{
+
31 BUTTON_1 = GLFW_MOUSE_BUTTON_1,
+
32 BUTTON_2 = GLFW_MOUSE_BUTTON_2,
+
33 BUTTON_3 = GLFW_MOUSE_BUTTON_3,
+
34 BUTTON_4 = GLFW_MOUSE_BUTTON_4,
+
35 BUTTON_5 = GLFW_MOUSE_BUTTON_5,
+
36 BUTTON_6 = GLFW_MOUSE_BUTTON_6,
+
37 BUTTON_7 = GLFW_MOUSE_BUTTON_7,
+
38 BUTTON_8 = GLFW_MOUSE_BUTTON_8,
+
39 BUTTON_LEFT = GLFW_MOUSE_BUTTON_LEFT,
+
40 BUTTON_RIGHT = GLFW_MOUSE_BUTTON_RIGHT,
+
41 BUTTON_MIDDLE = GLFW_MOUSE_BUTTON_MIDDLE,
+
42 BUTTON_LAST = GLFW_MOUSE_BUTTON_LAST,
+
43};
+
44
+
45class Mouse final
+
46{
+
47public:
+
48 explicit Mouse(GLFWwindow* window);
+
49 ~Mouse();
+
50
+
51 inline bool isButtonDown(vulk::Buttons button) const noexcept { return m_mouseInputs[static_cast<size_t>(button)]; }
+
52
+
53 void onButtonPressed(int button, int action);
+
54
+
55 [[nodiscard]] inline static Mouse* getMouse(GLFWwindow* window) { return s_linkedMouse[window]; }
+
56
+
57private:
+
58 static std::unordered_map<GLFWwindow*, Mouse*> s_linkedMouse;
+
59 std::array<bool, GLFW_MOUSE_BUTTON_LAST + 1> m_mouseInputs{};
+
60};
+
61} // namespace vulk
+
vulk::Mouse
Definition: Mouse.hpp:46
+
vulk::Mouse::onButtonPressed
void onButtonPressed(int button, int action)
+
vulk::Mouse::isButtonDown
bool isButtonDown(vulk::Buttons button) const noexcept
Definition: Mouse.hpp:51
+
vulk::Mouse::Mouse
Mouse(GLFWwindow *window)
+
vulk::Mouse::getMouse
static Mouse * getMouse(GLFWwindow *window)
Definition: Mouse.hpp:55
+ +
vulk
Definition: ContextGLFW.hpp:26
+
vulk::Buttons
Buttons
Definition: Mouse.hpp:30
+ + + + + + + + + + + + +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_objects_8hpp.html b/docs/html/_objects_8hpp.html new file mode 100644 index 0000000..0db64bc --- /dev/null +++ b/docs/html/_objects_8hpp.html @@ -0,0 +1,69 @@ + + + + + + + +Vulk: lib/include/Vulk/Objects.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Classes
+
Objects.hpp File Reference
+
+
+
#include <glm/glm.hpp>
+#include <vulkan/vulkan.hpp>
+
+

Go to the source code of this file.

+ + + + + + +

+Classes

struct  Vertex
 
struct  UniformBufferObject
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_objects_8hpp_source.html b/docs/html/_objects_8hpp_source.html new file mode 100644 index 0000000..f28f99c --- /dev/null +++ b/docs/html/_objects_8hpp_source.html @@ -0,0 +1,103 @@ + + + + + + + +Vulk: lib/include/Vulk/Objects.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
Objects.hpp
+
+
+Go to the documentation of this file.
1/*
+
2 * Copyright (c) 2021-2021 [fill name later]
+
3 *
+
4 * This software is provided "as-is", without any express or implied warranty. In no event
+
5 * will the authors be held liable for any damages arising from the use of this software.
+
6 *
+
7 * Permission is granted to anyone to use this software for any purpose, including commercial
+
8 * applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
9 *
+
10 * 1. The origin of this software must not be misrepresented; you must not claim that you
+
11 * wrote the original software. If you use this software in a product, an acknowledgment
+
12 * in the product documentation would be appreciated but is not required.
+
13 *
+
14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
+
15 * as being the original software.
+
16 *
+
17 * 3. This notice may not be removed or altered from any source distribution.
+
18 */
+
19
+
20#pragma once
+
21
+
22#include <glm/glm.hpp>
+
23#include <vulkan/vulkan.hpp>
+
24
+
25struct Vertex
+
26{
+
27 glm::vec2 position{};
+
28 glm::vec3 color{};
+
29
+
30 using AttributeDescriptions = std::array<vk::VertexInputAttributeDescription, 2>;
+
31
+
32 static vk::VertexInputBindingDescription getBindingDescription() noexcept;
+
33 static AttributeDescriptions getAttributeDescriptions() noexcept;
+
34};
+
35
+
36struct alignas(16) UniformBufferObject
+
37{
+
38 glm::mat4 model{};
+
39 glm::mat4 view{};
+
40 glm::mat4 projection{};
+
41};
+
UniformBufferObject
Definition: Objects.hpp:37
+
Vertex
Definition: Objects.hpp:26
+
Vertex::color
glm::vec3 color
Definition: Objects.hpp:28
+
Vertex::position
glm::vec2 position
Definition: Objects.hpp:27
+
Vertex::getBindingDescription
static vk::VertexInputBindingDescription getBindingDescription() noexcept
+
Vertex::AttributeDescriptions
std::array< vk::VertexInputAttributeDescription, 2 > AttributeDescriptions
Definition: Objects.hpp:30
+
Vertex::getAttributeDescriptions
static AttributeDescriptions getAttributeDescriptions() noexcept
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_rect_8hpp.html b/docs/html/_rect_8hpp.html new file mode 100644 index 0000000..b1556b7 --- /dev/null +++ b/docs/html/_rect_8hpp.html @@ -0,0 +1,86 @@ + + + + + + + +Vulk: lib/include/Vulk/Rect.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Classes | +Namespaces | +Typedefs
+
Rect.hpp File Reference
+
+
+
#include <Vulk/Vec2.hpp>
+#include <algorithm>
+#include <ostream>
+
+

Go to the source code of this file.

+ + + + +

+Classes

struct  vulk::Rect< T >
 
+ + + +

+Namespaces

namespace  vulk
 
+ + + + + + + + + +

+Typedefs

using vulk::Rectf = Rect< float >
 
using vulk::Rectd = Rect< double >
 
using vulk::Recti = Rect< int >
 
using vulk::Rectu = Rect< unsigned int >
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_rect_8hpp_source.html b/docs/html/_rect_8hpp_source.html new file mode 100644 index 0000000..2ab7fed --- /dev/null +++ b/docs/html/_rect_8hpp_source.html @@ -0,0 +1,152 @@ + + + + + + + +Vulk: lib/include/Vulk/Rect.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
Rect.hpp
+
+
+Go to the documentation of this file.
1/*
+
2 * Copyright (c) 2021-2021 [fill name later]
+
3 *
+
4 * This software is provided "as-is", without any express or implied warranty. In no event
+
5 * will the authors be held liable for any damages arising from the use of this software.
+
6 *
+
7 * Permission is granted to anyone to use this software for any purpose, including commercial
+
8 * applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
9 *
+
10 * 1. The origin of this software must not be misrepresented; you must not claim that you
+
11 * wrote the original software. If you use this software in a product, an acknowledgment
+
12 * in the product documentation would be appreciated but is not required.
+
13 *
+
14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
+
15 * as being the original software.
+
16 *
+
17 * 3. This notice may not be removed or altered from any source distribution.
+
18 */
+
19
+
20#pragma once
+
21
+
22#include <Vulk/Vec2.hpp>
+
23
+
24#include <algorithm>
+
25#include <ostream>
+
26
+
27namespace vulk {
+
28template<typename T>
+
29struct Rect
+
30{
+
31 T left;
+
32 T top;
+
33 T width;
+
34 T height;
+
35
+
36 constexpr Rect() = default;
+
37 constexpr Rect(T aLeft, T aTop, T aWidth, T aHeight) : left{aLeft}, top{aTop}, width{aWidth}, height{aHeight} {}
+
38 constexpr Rect(const Vec2<T>& pos, const Vec2<T>& size) : left{pos.x}, top{pos.y}, width{size.x}, height{size.y} {}
+
39
+
40 constexpr bool operator==(const Rect<T>& right) const noexcept
+
41 {
+
42 return left == right.left && top == right.top && width == right.width && height == right.height;
+
43 }
+
44
+
45 constexpr bool operator!=(const Rect<T>& right) const noexcept
+
46 {
+
47 return left != right.left || top != right.top || width != right.width || height != right.height;
+
48 }
+
49
+
50 [[nodiscard]] constexpr bool contains(T x, T y) const noexcept
+
51 {
+
52 const T minX = std::min(left, static_cast<T>(left + width));
+
53 const T maxX = std::max(left, static_cast<T>(left + width));
+
54 const T minY = std::min(top, static_cast<T>(top + height));
+
55 const T maxY = std::max(top, static_cast<T>(top + height));
+
56
+
57 return (x >= minX) && (x <= maxX) && (y >= minY) && (y <= maxY);
+
58 }
+
59
+
60 [[nodiscard]] constexpr bool contains(const Vec2<T>& point) const noexcept
+
61 {
+
62 const T minX = std::min(left, static_cast<T>(left + width));
+
63 const T maxX = std::max(left, static_cast<T>(left + width));
+
64 const T minY = std::min(top, static_cast<T>(top + height));
+
65 const T maxY = std::max(top, static_cast<T>(top + height));
+
66
+
67 return (point.x >= minX) && (point.x <= maxX) && (point.y >= minY) && (point.y <= maxY);
+
68 }
+
69
+
70 constexpr friend std::ostream& operator<<(std::ostream& os, const Rect<T>& rect) noexcept
+
71 {
+
72 return os << rect.left << ' ' << rect.top << ' ' << rect.width << ' ' << rect.height;
+
73 }
+
74};
+
75
+
76using Rectf = Rect<float>;
+
77using Rectd = Rect<double>;
+
78using Recti = Rect<int>;
+
79using Rectu = Rect<unsigned int>;
+
80} // namespace vulk
+ +
vulk
Definition: ContextGLFW.hpp:26
+ +
vulk::Rect
Definition: Rect.hpp:30
+
vulk::Rect::contains
constexpr bool contains(T x, T y) const noexcept
Definition: Rect.hpp:50
+
vulk::Rect::left
T left
Definition: Rect.hpp:31
+
vulk::Rect::operator!=
constexpr bool operator!=(const Rect< T > &right) const noexcept
Definition: Rect.hpp:45
+
vulk::Rect::Rect
constexpr Rect()=default
+
vulk::Rect::operator<<
constexpr friend std::ostream & operator<<(std::ostream &os, const Rect< T > &rect) noexcept
Definition: Rect.hpp:70
+
vulk::Rect::contains
constexpr bool contains(const Vec2< T > &point) const noexcept
Definition: Rect.hpp:60
+
vulk::Rect::operator==
constexpr bool operator==(const Rect< T > &right) const noexcept
Definition: Rect.hpp:40
+
vulk::Rect::Rect
constexpr Rect(T aLeft, T aTop, T aWidth, T aHeight)
Definition: Rect.hpp:37
+
vulk::Rect::height
T height
Definition: Rect.hpp:34
+
vulk::Rect::top
T top
Definition: Rect.hpp:32
+
vulk::Rect::width
T width
Definition: Rect.hpp:33
+
vulk::Rect::Rect
constexpr Rect(const Vec2< T > &pos, const Vec2< T > &size)
Definition: Rect.hpp:38
+
vulk::Vec2
Definition: Vec2.hpp:28
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_scoped_profiler_8hpp.html b/docs/html/_scoped_profiler_8hpp.html new file mode 100644 index 0000000..bdd1e34 --- /dev/null +++ b/docs/html/_scoped_profiler_8hpp.html @@ -0,0 +1,160 @@ + + + + + + + +Vulk: lib/include/Vulk/ScopedProfiler.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Classes | +Namespaces | +Macros
+
ScopedProfiler.hpp File Reference
+
+
+
#include <chrono>
+#include <utility>
+
+

Go to the source code of this file.

+ + + + +

+Classes

class  vulk::utils::ScopedProfiler
 
+ + + + + +

+Namespaces

namespace  vulk
 
namespace  vulk::utils
 
+ + + + + + + +

+Macros

#define VULK_STR_IMPL(x, y)   x##y
 
#define VULK_STR(x, y)   VULK_STR_IMPL(x, y)
 
#define VULK_SCOPED_PROFILER(x)   (void) 0
 
+

Macro Definition Documentation

+ +

◆ VULK_SCOPED_PROFILER

+ +
+
+ + + + + + + + +
#define VULK_SCOPED_PROFILER( x)   (void) 0
+
+ +
+
+ +

◆ VULK_STR

+ +
+
+ + + + + + + + + + + + + + + + + + +
#define VULK_STR( x,
 y 
)   VULK_STR_IMPL(x, y)
+
+ +
+
+ +

◆ VULK_STR_IMPL

+ +
+
+ + + + + + + + + + + + + + + + + + +
#define VULK_STR_IMPL( x,
 y 
)   x##y
+
+ +
+
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_scoped_profiler_8hpp_source.html b/docs/html/_scoped_profiler_8hpp_source.html new file mode 100644 index 0000000..7ce289d --- /dev/null +++ b/docs/html/_scoped_profiler_8hpp_source.html @@ -0,0 +1,122 @@ + + + + + + + +Vulk: lib/include/Vulk/ScopedProfiler.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
ScopedProfiler.hpp
+
+
+Go to the documentation of this file.
1/*
+
2 * Copyright (c) 2021-2021 [fill name later]
+
3 *
+
4 * This software is provided "as-is", without any express or implied warranty. In no event
+
5 * will the authors be held liable for any damages arising from the use of this software.
+
6 *
+
7 * Permission is granted to anyone to use this software for any purpose, including commercial
+
8 * applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
9 *
+
10 * 1. The origin of this software must not be misrepresented; you must not claim that you
+
11 * wrote the original software. If you use this software in a product, an acknowledgment
+
12 * in the product documentation would be appreciated but is not required.
+
13 *
+
14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
+
15 * as being the original software.
+
16 *
+
17 * 3. This notice may not be removed or altered from any source distribution.
+
18 */
+
19
+
20#pragma once
+
21
+
22#include <chrono>
+
23#include <utility>
+
24
+
25namespace vulk::utils {
+
26class ScopedProfiler final
+
27{
+
28public:
+
29 using Clock = std::chrono::high_resolution_clock;
+
30 using TimePoint = decltype(Clock::now());
+
31 using DurationSeconds = std::chrono::duration<double>;
+
32 using DurationMillis = std::chrono::duration<double, std::milli>;
+
33
+
34 explicit ScopedProfiler(const char* name) noexcept;
+
35 ~ScopedProfiler();
+
36
+
37 ScopedProfiler(ScopedProfiler&&) = delete;
+
38 ScopedProfiler(const ScopedProfiler&) = delete;
+
39 ScopedProfiler& operator=(ScopedProfiler&&) = delete;
+
40 ScopedProfiler& operator=(const ScopedProfiler&) = delete;
+
41
+
42private:
+
43 const TimePoint m_start;
+
44 const char* const m_name;
+
45};
+
46} // namespace vulk::utils
+
47
+
48#define VULK_STR_IMPL(x, y) x##y
+
49#define VULK_STR(x, y) VULK_STR_IMPL(x, y)
+
50
+
51#if VULK_WITH_SCOPED_PROFILER
+
52 #define VULK_SCOPED_PROFILER(x) const vulk::utils::ScopedProfiler VULK_STR(_SCOPED_PROFILER_, __LINE__)(x)
+
53#else
+
54 #define VULK_SCOPED_PROFILER(x) (void) 0
+
55#endif
+
vulk::utils::ScopedProfiler
Definition: ScopedProfiler.hpp:27
+
vulk::utils::ScopedProfiler::ScopedProfiler
ScopedProfiler(ScopedProfiler &&)=delete
+
vulk::utils::ScopedProfiler::DurationSeconds
std::chrono::duration< double > DurationSeconds
Definition: ScopedProfiler.hpp:31
+ +
vulk::utils::ScopedProfiler::operator=
ScopedProfiler & operator=(ScopedProfiler &&)=delete
+
vulk::utils::ScopedProfiler::TimePoint
decltype(Clock::now()) TimePoint
Definition: ScopedProfiler.hpp:30
+
vulk::utils::ScopedProfiler::ScopedProfiler
ScopedProfiler(const char *name) noexcept
+
vulk::utils::ScopedProfiler::ScopedProfiler
ScopedProfiler(const ScopedProfiler &)=delete
+
vulk::utils::ScopedProfiler::Clock
std::chrono::high_resolution_clock Clock
Definition: ScopedProfiler.hpp:29
+
vulk::utils::ScopedProfiler::DurationMillis
std::chrono::duration< double, std::milli > DurationMillis
Definition: ScopedProfiler.hpp:32
+
vulk::utils::ScopedProfiler::operator=
ScopedProfiler & operator=(const ScopedProfiler &)=delete
+
vulk::utils
Definition: ScopedProfiler.hpp:25
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_shader_8hpp.html b/docs/html/_shader_8hpp.html new file mode 100644 index 0000000..b3316c3 --- /dev/null +++ b/docs/html/_shader_8hpp.html @@ -0,0 +1,74 @@ + + + + + + + +Vulk: lib/include/Vulk/Shader.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Classes | +Namespaces
+
Shader.hpp File Reference
+
+
+
#include <vulkan/vulkan.hpp>
+#include <cstdint>
+#include <vector>
+
+

Go to the source code of this file.

+ + + + +

+Classes

class  vulk::Shader
 
+ + + +

+Namespaces

namespace  vulk
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_shader_8hpp_source.html b/docs/html/_shader_8hpp_source.html new file mode 100644 index 0000000..136fcc5 --- /dev/null +++ b/docs/html/_shader_8hpp_source.html @@ -0,0 +1,111 @@ + + + + + + + +Vulk: lib/include/Vulk/Shader.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
Shader.hpp
+
+
+Go to the documentation of this file.
1/*
+
2* Copyright (c) 2021-2021 [fill name later]
+
3*
+
4* This software is provided "as-is", without any express or implied warranty. In no event
+
5* will the authors be held liable for any damages arising from the use of this software.
+
6*
+
7* Permission is granted to anyone to use this software for any purpose, including commercial
+
8* applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
9*
+
10* 1. The origin of this software must not be misrepresented; you must not claim that you
+
11* wrote the original software. If you use this software in a product, an acknowledgment
+
12* in the product documentation would be appreciated but is not required.
+
13*
+
14* 2. Altered source versions must be plainly marked as such, and must not be misrepresented
+
15* as being the original software.
+
16*
+
17* 3. This notice may not be removed or altered from any source distribution.
+
18*/
+
19
+
20#pragma once
+
21
+
22#include <vulkan/vulkan.hpp>
+
23
+
24#include <cstdint>
+
25#include <vector>
+
26
+
27namespace vulk {
+
28class Shader
+
29{
+
30public:
+
31 using Type = vk::ShaderStageFlagBits;
+
32
+
33 Shader(vk::Device& device, const char* filePath, Type type);
+
34 ~Shader();
+
35
+
36 [[nodiscard]] const vk::PipelineShaderStageCreateInfo& getShaderStageCreateInfo() const noexcept
+
37 {
+
38 return m_pipelineShaderStageCreateInfo;
+
39 }
+
40
+
41private:
+
42 vk::Device m_device; // TODO: Remove once vk::raii is implemented
+
43
+
44 std::vector<char> m_buffer{};
+
45 vk::ShaderModule m_shaderModule{};
+
46 vk::PipelineShaderStageCreateInfo m_pipelineShaderStageCreateInfo{};
+
47
+
48 Type m_type{};
+
49};
+
50} // namespace vulk
+
vulk::Shader
Definition: Shader.hpp:29
+
vulk::Shader::getShaderStageCreateInfo
const vk::PipelineShaderStageCreateInfo & getShaderStageCreateInfo() const noexcept
Definition: Shader.hpp:36
+
vulk::Shader::Type
vk::ShaderStageFlagBits Type
Definition: Shader.hpp:31
+
vulk::Shader::Shader
Shader(vk::Device &device, const char *filePath, Type type)
+ +
vulk
Definition: ContextGLFW.hpp:26
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_time_8hpp.html b/docs/html/_time_8hpp.html new file mode 100644 index 0000000..6103a2b --- /dev/null +++ b/docs/html/_time_8hpp.html @@ -0,0 +1,76 @@ + + + + + + + +Vulk: lib/include/Vulk/Time.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Namespaces | +Typedefs
+
Time.hpp File Reference
+
+
+
#include <chrono>
+
+

Go to the source code of this file.

+ + + + +

+Namespaces

namespace  vulk
 
+ + + + + + + +

+Typedefs

using vulk::Clock = std::chrono::high_resolution_clock
 
using vulk::Duration = std::chrono::duration< float >
 
using vulk::TimePoint = decltype(Clock::now())
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_time_8hpp_source.html b/docs/html/_time_8hpp_source.html new file mode 100644 index 0000000..53c4f6a --- /dev/null +++ b/docs/html/_time_8hpp_source.html @@ -0,0 +1,87 @@ + + + + + + + +Vulk: lib/include/Vulk/Time.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
Time.hpp
+
+
+Go to the documentation of this file.
1/*
+
2 * Copyright (c) 2021-2021 [fill name later]
+
3 *
+
4 * This software is provided "as-is", without any express or implied warranty. In no event
+
5 * will the authors be held liable for any damages arising from the use of this software.
+
6 *
+
7 * Permission is granted to anyone to use this software for any purpose, including commercial
+
8 * applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
9 *
+
10 * 1. The origin of this software must not be misrepresented; you must not claim that you
+
11 * wrote the original software. If you use this software in a product, an acknowledgment
+
12 * in the product documentation would be appreciated but is not required.
+
13 *
+
14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
+
15 * as being the original software.
+
16 *
+
17 * 3. This notice may not be removed or altered from any source distribution.
+
18 */
+
19
+
20#pragma once
+
21
+
22#include <chrono>
+
23
+
24namespace vulk {
+
25using Clock = std::chrono::high_resolution_clock;
+
26using Duration = std::chrono::duration<float>;
+
27using TimePoint = decltype(Clock::now());
+
28} // namespace vulk
+
vulk
Definition: ContextGLFW.hpp:26
+
vulk::Clock
std::chrono::high_resolution_clock Clock
Definition: Time.hpp:25
+
vulk::TimePoint
decltype(Clock::now()) TimePoint
Definition: Time.hpp:27
+
vulk::Duration
std::chrono::duration< float > Duration
Definition: Time.hpp:26
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_utils_8hpp.html b/docs/html/_utils_8hpp.html new file mode 100644 index 0000000..98db1f3 --- /dev/null +++ b/docs/html/_utils_8hpp.html @@ -0,0 +1,77 @@ + + + + + + + +Vulk: lib/include/Vulk/Utils.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Namespaces | +Functions
+
Utils.hpp File Reference
+
+
+
#include <vector>
+
+

Go to the source code of this file.

+ + + + + + +

+Namespaces

namespace  vulk
 
namespace  vulk::utils
 
+ + + + + + +

+Functions

template<typename T , typename Allocator >
bool vulk::utils::vectorContains (const std::vector< T, Allocator > &vector, const T &element)
 
std::vector< char > vulk::utils::fileToBinary (const char *filePath)
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_utils_8hpp_source.html b/docs/html/_utils_8hpp_source.html new file mode 100644 index 0000000..d88f711 --- /dev/null +++ b/docs/html/_utils_8hpp_source.html @@ -0,0 +1,87 @@ + + + + + + + +Vulk: lib/include/Vulk/Utils.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
Utils.hpp
+
+
+Go to the documentation of this file.
1/*
+
2** Copyright 2021 Maxime Houis
+
3**
+
4** Licensed under the Apache License, Version 2.0 (the "License");
+
5** you may not use this file except in compliance with the License.
+
6** You may obtain a copy of the License at
+
7**
+
8** http://www.apache.org/licenses/LICENSE-2.0
+
9**
+
10** Unless required by applicable law or agreed to in writing, software
+
11** distributed under the License is distributed on an "AS IS" BASIS,
+
12** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+
13** See the License for the specific language governing permissions and
+
14** limitations under the License.
+
15*/
+
16
+
17#pragma once
+
18
+
19#include <vector>
+
20
+
21namespace vulk::utils {
+
22template<typename T, typename Allocator>
+
23[[nodiscard]] bool vectorContains(const std::vector<T, Allocator>& vector, const T& element)
+
24{
+
25 return std::find(vector.cbegin(), vector.cend(), element) != vector.cend();
+
26}
+
27
+
28std::vector<char> fileToBinary(const char* filePath);
+
29} // namespace vulk::utils
+
vulk::utils
Definition: ScopedProfiler.hpp:25
+
vulk::utils::vectorContains
bool vectorContains(const std::vector< T, Allocator > &vector, const T &element)
Definition: Utils.hpp:23
+
vulk::utils::fileToBinary
std::vector< char > fileToBinary(const char *filePath)
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_vec2_8hpp.html b/docs/html/_vec2_8hpp.html new file mode 100644 index 0000000..d420f16 --- /dev/null +++ b/docs/html/_vec2_8hpp.html @@ -0,0 +1,107 @@ + + + + + + + +Vulk: lib/include/Vulk/Vec2.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Classes | +Namespaces | +Typedefs | +Functions
+
Vec2.hpp File Reference
+
+
+
#include <cmath>
+#include <ostream>
+
+

Go to the source code of this file.

+ + + + +

+Classes

struct  vulk::Vec2< T >
 
+ + + +

+Namespaces

namespace  vulk
 
+ + + + + + + + + +

+Typedefs

using vulk::Vec2f = Vec2< float >
 
using vulk::Vec2d = Vec2< double >
 
using vulk::Vec2i = Vec2< int >
 
using vulk::Vec2u = Vec2< unsigned int >
 
+ + + + + + + + + + + + + + + + + + + +

+Functions

template<typename T >
constexpr Vec2< T > vulk::operator+ (const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
 
template<typename T >
constexpr Vec2< T > vulk::operator- (const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
 
template<typename T >
constexpr Vec2< T > vulk::operator* (const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
 
template<typename T >
constexpr Vec2< T > vulk::operator* (const Vec2< T > &lhs, T t) noexcept
 
template<typename T >
constexpr Vec2< T > vulk::operator* (T t, const Vec2< T > &rhs) noexcept
 
template<typename T >
constexpr Vec2< T > vulk::operator/ (const Vec2< T > &lhs, T t) noexcept
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_vec2_8hpp_source.html b/docs/html/_vec2_8hpp_source.html new file mode 100644 index 0000000..1e8eb5d --- /dev/null +++ b/docs/html/_vec2_8hpp_source.html @@ -0,0 +1,199 @@ + + + + + + + +Vulk: lib/include/Vulk/Vec2.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
Vec2.hpp
+
+
+Go to the documentation of this file.
1/*
+
2 * Copyright (c) 2021-2021 [fill name later]
+
3 *
+
4 * This software is provided "as-is", without any express or implied warranty. In no event
+
5 * will the authors be held liable for any damages arising from the use of this software.
+
6 *
+
7 * Permission is granted to anyone to use this software for any purpose, including commercial
+
8 * applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
9 *
+
10 * 1. The origin of this software must not be misrepresented; you must not claim that you
+
11 * wrote the original software. If you use this software in a product, an acknowledgment
+
12 * in the product documentation would be appreciated but is not required.
+
13 *
+
14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
+
15 * as being the original software.
+
16 *
+
17 * 3. This notice may not be removed or altered from any source distribution.
+
18 */
+
19
+
20#pragma once
+
21
+
22#include <cmath>
+
23#include <ostream>
+
24
+
25namespace vulk {
+
26template<typename T>
+
27struct Vec2
+
28{
+
29 T x;
+
30 T y;
+
31
+
32 constexpr Vec2() = default;
+
33 constexpr Vec2(T aX, T aY) : x{aX}, y{aY} {}
+
34 constexpr explicit Vec2(T value) : x{value}, y{value} {}
+
35
+
36 constexpr Vec2 operator-() const noexcept { return Vec2{-x, -y}; }
+
37
+
38 constexpr Vec2& operator+=(const Vec2& rhs)
+
39 {
+
40 x += rhs.x;
+
41 y += rhs.y;
+
42 return *this;
+
43 }
+
44
+
45 constexpr Vec2& operator-=(const Vec2& rhs)
+
46 {
+
47 x -= rhs.x;
+
48 y -= rhs.y;
+
49 return *this;
+
50 }
+
51
+
52 constexpr Vec2& operator*=(const T value)
+
53 {
+
54 x *= value;
+
55 y *= value;
+
56 return *this;
+
57 }
+
58
+
59 constexpr Vec2& operator/=(const T value) { return *this *= (static_cast<T>(1) / value); }
+
60
+
61 [[nodiscard]] constexpr static T dot(const Vec2& lhs, const Vec2& rhs) noexcept
+
62 {
+
63 return lhs.x * rhs.x + lhs.y * rhs.y;
+
64 }
+
65
+
66 [[nodiscard]] constexpr static T cross(const Vec2& lhs, const Vec2& rhs) noexcept
+
67 {
+
68 return lhs.x * rhs.y - lhs.y * rhs.x;
+
69 }
+
70
+
71 [[nodiscard]] constexpr T lengthSquared() const noexcept { return x * x + y * y; }
+
72 [[nodiscard]] constexpr T length() const noexcept { return static_cast<T>(std::sqrt(lengthSquared())); }
+
73 [[nodiscard]] constexpr Vec2 normalized() const noexcept { return *this / length(); }
+
74
+
75 constexpr friend std::ostream& operator<<(std::ostream& os, const Vec2& Vec2) noexcept
+
76 {
+
77 return os << Vec2.x << ' ' << Vec2.y << ' ';
+
78 }
+
79};
+
80
+
81template<typename T>
+
82constexpr Vec2<T> operator+(const Vec2<T>& lhs, const Vec2<T>& rhs) noexcept
+
83{
+
84 return Vec2{lhs.x + rhs.x, lhs.y + rhs.y};
+
85}
+
86
+
87template<typename T>
+
88constexpr Vec2<T> operator-(const Vec2<T>& lhs, const Vec2<T>& rhs) noexcept
+
89{
+
90 return Vec2{lhs.x - rhs.x, lhs.y - rhs.y};
+
91}
+
92
+
93template<typename T>
+
94constexpr Vec2<T> operator*(const Vec2<T>& lhs, const Vec2<T>& rhs) noexcept
+
95{
+
96 return Vec2{lhs.x * rhs.x, lhs.y * rhs.y};
+
97}
+
98
+
99template<typename T>
+
100constexpr Vec2<T> operator*(const Vec2<T>& lhs, T t) noexcept
+
101{
+
102 return Vec2{lhs.x * t, lhs.y * t};
+
103}
+
104
+
105template<typename T>
+
106constexpr Vec2<T> operator*(T t, const Vec2<T>& rhs) noexcept
+
107{
+
108 return rhs * t;
+
109}
+
110
+
111template<typename T>
+
112constexpr Vec2<T> operator/(const Vec2<T>& lhs, T t) noexcept
+
113{
+
114 return (1 / t) * lhs;
+
115}
+
116
+
117using Vec2f = Vec2<float>;
+
118using Vec2d = Vec2<double>;
+
119using Vec2i = Vec2<int>;
+
120using Vec2u = Vec2<unsigned int>;
+
121} // namespace vulk
+
vulk
Definition: ContextGLFW.hpp:26
+
vulk::operator*
constexpr Vec2< T > operator*(const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
Definition: Vec2.hpp:94
+
vulk::operator/
constexpr Vec2< T > operator/(const Vec2< T > &lhs, T t) noexcept
Definition: Vec2.hpp:112
+
vulk::operator+
constexpr Vec2< T > operator+(const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
Definition: Vec2.hpp:82
+ +
vulk::operator-
constexpr Vec2< T > operator-(const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
Definition: Vec2.hpp:88
+
vulk::Vec2
Definition: Vec2.hpp:28
+
vulk::Vec2::normalized
constexpr Vec2 normalized() const noexcept
Definition: Vec2.hpp:73
+
vulk::Vec2::Vec2
constexpr Vec2()=default
+
vulk::Vec2::x
T x
Definition: Vec2.hpp:29
+
vulk::Vec2::lengthSquared
constexpr T lengthSquared() const noexcept
Definition: Vec2.hpp:71
+
vulk::Vec2::length
constexpr T length() const noexcept
Definition: Vec2.hpp:72
+
vulk::Vec2::y
T y
Definition: Vec2.hpp:30
+
vulk::Vec2::Vec2
constexpr Vec2(T aX, T aY)
Definition: Vec2.hpp:33
+
vulk::Vec2::cross
static constexpr T cross(const Vec2 &lhs, const Vec2 &rhs) noexcept
Definition: Vec2.hpp:66
+
vulk::Vec2::operator+=
constexpr Vec2 & operator+=(const Vec2 &rhs)
Definition: Vec2.hpp:38
+
vulk::Vec2::operator-
constexpr Vec2 operator-() const noexcept
Definition: Vec2.hpp:36
+
vulk::Vec2::operator-=
constexpr Vec2 & operator-=(const Vec2 &rhs)
Definition: Vec2.hpp:45
+
vulk::Vec2::operator<<
constexpr friend std::ostream & operator<<(std::ostream &os, const Vec2 &Vec2) noexcept
Definition: Vec2.hpp:75
+
vulk::Vec2::Vec2
constexpr Vec2(T value)
Definition: Vec2.hpp:34
+
vulk::Vec2::operator/=
constexpr Vec2 & operator/=(const T value)
Definition: Vec2.hpp:59
+
vulk::Vec2::operator*=
constexpr Vec2 & operator*=(const T value)
Definition: Vec2.hpp:52
+
vulk::Vec2::dot
static constexpr T dot(const Vec2 &lhs, const Vec2 &rhs) noexcept
Definition: Vec2.hpp:61
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_vec3_8hpp.html b/docs/html/_vec3_8hpp.html new file mode 100644 index 0000000..bae0fac --- /dev/null +++ b/docs/html/_vec3_8hpp.html @@ -0,0 +1,107 @@ + + + + + + + +Vulk: lib/include/Vulk/Vec3.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Classes | +Namespaces | +Typedefs | +Functions
+
Vec3.hpp File Reference
+
+
+
#include <cmath>
+#include <ostream>
+
+

Go to the source code of this file.

+ + + + +

+Classes

struct  vulk::Vec3< T >
 
+ + + +

+Namespaces

namespace  vulk
 
+ + + + + + + + + +

+Typedefs

using vulk::Vec3f = Vec3< float >
 
using vulk::Vec3d = Vec3< double >
 
using vulk::Vec3i = Vec3< int >
 
using vulk::Vec3u = Vec3< unsigned int >
 
+ + + + + + + + + + + + + + + + + + + +

+Functions

template<typename T >
constexpr Vec3< T > vulk::operator+ (const Vec3< T > &lhs, const Vec3< T > &rhs) noexcept
 
template<typename T >
constexpr Vec3< T > vulk::operator- (const Vec3< T > &lhs, const Vec3< T > &rhs) noexcept
 
template<typename T >
constexpr Vec3< T > vulk::operator* (const Vec3< T > &lhs, const Vec3< T > &rhs) noexcept
 
template<typename T >
constexpr Vec3< T > vulk::operator* (const Vec3< T > &lhs, T t) noexcept
 
template<typename T >
constexpr Vec3< T > vulk::operator* (T t, const Vec3< T > &rhs) noexcept
 
template<typename T >
constexpr Vec3< T > vulk::operator/ (const Vec3< T > &lhs, T t) noexcept
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_vec3_8hpp_source.html b/docs/html/_vec3_8hpp_source.html new file mode 100644 index 0000000..a10c62c --- /dev/null +++ b/docs/html/_vec3_8hpp_source.html @@ -0,0 +1,204 @@ + + + + + + + +Vulk: lib/include/Vulk/Vec3.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
Vec3.hpp
+
+
+Go to the documentation of this file.
1/*
+
2 * Copyright (c) 2021-2021 [fill name later]
+
3 *
+
4 * This software is provided "as-is", without any express or implied warranty. In no event
+
5 * will the authors be held liable for any damages arising from the use of this software.
+
6 *
+
7 * Permission is granted to anyone to use this software for any purpose, including commercial
+
8 * applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
9 *
+
10 * 1. The origin of this software must not be misrepresented; you must not claim that you
+
11 * wrote the original software. If you use this software in a product, an acknowledgment
+
12 * in the product documentation would be appreciated but is not required.
+
13 *
+
14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
+
15 * as being the original software.
+
16 *
+
17 * 3. This notice may not be removed or altered from any source distribution.
+
18 */
+
19
+
20#pragma once
+
21
+
22#include <cmath>
+
23#include <ostream>
+
24
+
25namespace vulk {
+
26template<typename T>
+
27struct Vec3
+
28{
+
29 T x;
+
30 T y;
+
31 T z;
+
32
+
33 constexpr Vec3() = default;
+
34 constexpr Vec3(T aX, T aY, T aZ) : x{aX}, y{aY}, z{aZ} {}
+
35 constexpr explicit Vec3(T value) : x{value}, y{value}, z{value} {}
+
36
+
37 constexpr Vec3 operator-() const noexcept { return Vec3{-x, -y, -z}; }
+
38
+
39 constexpr Vec3& operator+=(const Vec3& rhs)
+
40 {
+
41 x += rhs.x;
+
42 y += rhs.y;
+
43 z += rhs.z;
+
44 return *this;
+
45 }
+
46
+
47 constexpr Vec3& operator-=(const Vec3& rhs)
+
48 {
+
49 x -= rhs.x;
+
50 y -= rhs.y;
+
51 z -= rhs.z;
+
52 return *this;
+
53 }
+
54
+
55 constexpr Vec3& operator*=(const T value)
+
56 {
+
57 x *= value;
+
58 y *= value;
+
59 z *= value;
+
60 return *this;
+
61 }
+
62
+
63 constexpr Vec3& operator/=(const T value) { return *this *= (static_cast<T>(1) / value); }
+
64
+
65 [[nodiscard]] constexpr static T dot(const Vec3& lhs, const Vec3& rhs) noexcept
+
66 {
+
67 return lhs.x * rhs.x + lhs.y * rhs.y + lhs.z * rhs.z;
+
68 }
+
69
+
70 [[nodiscard]] constexpr static Vec3 cross(const Vec3& lhs, const Vec3& rhs) noexcept
+
71 {
+
72 return Vec3{lhs.y * rhs.z - lhs.z * rhs.y, lhs.z * rhs.x - lhs.x * rhs.z, lhs.x * rhs.y - lhs.y * rhs.x};
+
73 }
+
74
+
75 [[nodiscard]] constexpr T lengthSquared() const noexcept { return x * x + y * y + z * z; }
+
76 [[nodiscard]] constexpr T length() const noexcept { return static_cast<T>(std::sqrt(lengthSquared())); }
+
77 [[nodiscard]] constexpr Vec3 normalized() const noexcept { return *this / length(); }
+
78
+
79 constexpr friend std::ostream& operator<<(std::ostream& os, const Vec3& vec3) noexcept
+
80 {
+
81 return os << vec3.x << ' ' << vec3.y << ' ' << vec3.z;
+
82 }
+
83};
+
84
+
85template<typename T>
+
86constexpr Vec3<T> operator+(const Vec3<T>& lhs, const Vec3<T>& rhs) noexcept
+
87{
+
88 return Vec3{lhs.x + rhs.x, lhs.y + rhs.y, lhs.z + rhs.z};
+
89}
+
90
+
91template<typename T>
+
92constexpr Vec3<T> operator-(const Vec3<T>& lhs, const Vec3<T>& rhs) noexcept
+
93{
+
94 return Vec3{lhs.x - rhs.x, lhs.y - rhs.y, lhs.z - rhs.z};
+
95}
+
96
+
97template<typename T>
+
98constexpr Vec3<T> operator*(const Vec3<T>& lhs, const Vec3<T>& rhs) noexcept
+
99{
+
100 return Vec3{lhs.x * rhs.x, lhs.y * rhs.y, lhs.z * rhs.z};
+
101}
+
102
+
103template<typename T>
+
104constexpr Vec3<T> operator*(const Vec3<T>& lhs, T t) noexcept
+
105{
+
106 return Vec3{lhs.x * t, lhs.y * t, lhs.z * t};
+
107}
+
108
+
109template<typename T>
+
110constexpr Vec3<T> operator*(T t, const Vec3<T>& rhs) noexcept
+
111{
+
112 return rhs * t;
+
113}
+
114
+
115template<typename T>
+
116constexpr Vec3<T> operator/(const Vec3<T>& lhs, T t) noexcept
+
117{
+
118 return (1 / t) * lhs;
+
119}
+
120
+
121using Vec3f = Vec3<float>;
+
122using Vec3d = Vec3<double>;
+
123using Vec3i = Vec3<int>;
+
124using Vec3u = Vec3<unsigned int>;
+
125} // namespace vulk
+
vulk
Definition: ContextGLFW.hpp:26
+
vulk::operator*
constexpr Vec2< T > operator*(const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
Definition: Vec2.hpp:94
+
vulk::operator/
constexpr Vec2< T > operator/(const Vec2< T > &lhs, T t) noexcept
Definition: Vec2.hpp:112
+
vulk::operator+
constexpr Vec2< T > operator+(const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
Definition: Vec2.hpp:82
+ +
vulk::operator-
constexpr Vec2< T > operator-(const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
Definition: Vec2.hpp:88
+
vulk::Vec3
Definition: Vec3.hpp:28
+
vulk::Vec3::y
T y
Definition: Vec3.hpp:30
+
vulk::Vec3::operator/=
constexpr Vec3 & operator/=(const T value)
Definition: Vec3.hpp:63
+
vulk::Vec3::Vec3
constexpr Vec3(T aX, T aY, T aZ)
Definition: Vec3.hpp:34
+
vulk::Vec3::z
T z
Definition: Vec3.hpp:31
+
vulk::Vec3::length
constexpr T length() const noexcept
Definition: Vec3.hpp:76
+
vulk::Vec3::operator-=
constexpr Vec3 & operator-=(const Vec3 &rhs)
Definition: Vec3.hpp:47
+
vulk::Vec3::operator-
constexpr Vec3 operator-() const noexcept
Definition: Vec3.hpp:37
+
vulk::Vec3::normalized
constexpr Vec3 normalized() const noexcept
Definition: Vec3.hpp:77
+
vulk::Vec3::Vec3
constexpr Vec3(T value)
Definition: Vec3.hpp:35
+
vulk::Vec3::lengthSquared
constexpr T lengthSquared() const noexcept
Definition: Vec3.hpp:75
+
vulk::Vec3::Vec3
constexpr Vec3()=default
+
vulk::Vec3::x
T x
Definition: Vec3.hpp:29
+
vulk::Vec3::dot
static constexpr T dot(const Vec3 &lhs, const Vec3 &rhs) noexcept
Definition: Vec3.hpp:65
+
vulk::Vec3::operator<<
constexpr friend std::ostream & operator<<(std::ostream &os, const Vec3 &vec3) noexcept
Definition: Vec3.hpp:79
+
vulk::Vec3::cross
static constexpr Vec3 cross(const Vec3 &lhs, const Vec3 &rhs) noexcept
Definition: Vec3.hpp:70
+
vulk::Vec3::operator+=
constexpr Vec3 & operator+=(const Vec3 &rhs)
Definition: Vec3.hpp:39
+
vulk::Vec3::operator*=
constexpr Vec3 & operator*=(const T value)
Definition: Vec3.hpp:55
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_window_8hpp.html b/docs/html/_window_8hpp.html new file mode 100644 index 0000000..ea5f143 --- /dev/null +++ b/docs/html/_window_8hpp.html @@ -0,0 +1,75 @@ + + + + + + + +Vulk: lib/include/Vulk/Window.hpp File Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Classes | +Namespaces
+
Window.hpp File Reference
+
+
+
#include <memory>
+#include "FrameManager.hpp"
+#include "Keyboard.hpp"
+#include "Mouse.hpp"
+
+

Go to the source code of this file.

+ + + + +

+Classes

class  vulk::Window
 
+ + + +

+Namespaces

namespace  vulk
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/_window_8hpp_source.html b/docs/html/_window_8hpp_source.html new file mode 100644 index 0000000..a2a7818 --- /dev/null +++ b/docs/html/_window_8hpp_source.html @@ -0,0 +1,134 @@ + + + + + + + +Vulk: lib/include/Vulk/Window.hpp Source File + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
Window.hpp
+
+
+Go to the documentation of this file.
1/*
+
2 * Copyright (c) 2021-2021 [fill name later]
+
3 *
+
4 * This software is provided "as-is", without any express or implied warranty. In no event
+
5 * will the authors be held liable for any damages arising from the use of this software.
+
6 *
+
7 * Permission is granted to anyone to use this software for any purpose, including commercial
+
8 * applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
9 *
+
10 * 1. The origin of this software must not be misrepresented; you must not claim that you
+
11 * wrote the original software. If you use this software in a product, an acknowledgment
+
12 * in the product documentation would be appreciated but is not required.
+
13 *
+
14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
+
15 * as being the original software.
+
16 *
+
17 * 3. This notice may not be removed or altered from any source distribution.
+
18 */
+
19
+
20#pragma once
+
21
+
22#include <memory>
+
23
+
24#include "FrameManager.hpp"
+
25#include "Keyboard.hpp"
+
26#include "Mouse.hpp"
+
27
+
28struct GLFWwindow;
+
29
+
30namespace vulk {
+
35class Window
+
36{
+
37public:
+
45 Window(unsigned int width, unsigned int height, const char* title);
+
50 ~Window();
+
51
+
57 Window(Window&& rhs) noexcept;
+
64 Window& operator=(Window&& rhs) noexcept;
+
65
+
66 Window(const Window&) = delete;
+
67 Window& operator=(const Window&) = delete;
+
68
+
73 void display();
+
78 void pollEvents();
+
83 void close() noexcept;
+
84
+
91 void setTitle(const char* newTitle) noexcept;
+
92
+
99 [[nodiscard]] bool isOpen() const noexcept;
+
105 [[nodiscard]] FrameManager& getFrameManager() noexcept { return m_frameManager; }
+
111 [[nodiscard]] const FrameManager& getFrameManager() const noexcept { return m_frameManager; }
+
112
+
113private:
+
118 GLFWwindow* m_windowHandle{nullptr};
+
123 FrameManager m_frameManager{};
+
124
+
129 std::unique_ptr<Keyboard> m_keyboard{nullptr};
+
134 std::unique_ptr<Mouse> m_mouse{nullptr};
+
135};
+
136} // namespace vulk
+ + + +
vulk::FrameManager
Definition: FrameManager.hpp:32
+
vulk::Window
Definition: Window.hpp:36
+
vulk::Window::isOpen
bool isOpen() const noexcept
+
vulk::Window::Window
Window(const Window &)=delete
+
vulk::Window::operator=
Window & operator=(Window &&rhs) noexcept
+
vulk::Window::getFrameManager
const FrameManager & getFrameManager() const noexcept
Get the Frame Manager object.
Definition: Window.hpp:111
+
vulk::Window::setTitle
void setTitle(const char *newTitle) noexcept
Changes the title of the window.
+
vulk::Window::display
void display()
+
vulk::Window::operator=
Window & operator=(const Window &)=delete
+
vulk::Window::Window
Window(Window &&rhs) noexcept
Construct a new Window object.
+
vulk::Window::close
void close() noexcept
+
vulk::Window::pollEvents
void pollEvents()
+
vulk::Window::~Window
~Window()
Destroy the Window object.
+
vulk::Window::Window
Window(unsigned int width, unsigned int height, const char *title)
Construct a new Window object.
+
vulk::Window::getFrameManager
FrameManager & getFrameManager() noexcept
Get the Frame Manager object.
Definition: Window.hpp:105
+
vulk
Definition: ContextGLFW.hpp:26
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/annotated.html b/docs/html/annotated.html new file mode 100644 index 0000000..b36ef81 --- /dev/null +++ b/docs/html/annotated.html @@ -0,0 +1,75 @@ + + + + + + + +Vulk: Class List + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + +
+
+
Class List
+
+
+
Here are the classes, structs, unions and interfaces with brief descriptions:
+
[detail level 123]
+ + + + + + + + + + + + + + + + + + + + +
 ▼Nvulk
 ▼Nutils
 CScopedProfiler
 CContextGLFW
 CContextVulkan
 CException
 CFrameManager
 CGLFWException
 CKeyboard
 CMat3
 CMouse
 CRect
 CShader
 CVec2
 CVec3
 CVulkanException
 CWindow
 CTypeChecker
 CUniformBufferObject
 CVertex
+
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/bc_s.png b/docs/html/bc_s.png new file mode 100644 index 0000000000000000000000000000000000000000..224b29aa9847d5a4b3902efd602b7ddf7d33e6c2 GIT binary patch literal 676 zcmV;V0$crwP)y__>=_9%My z{n931IS})GlGUF8K#6VIbs%684A^L3@%PlP2>_sk`UWPq@f;rU*V%rPy_ekbhXT&s z(GN{DxFv}*vZp`F>S!r||M`I*nOwwKX+BC~3P5N3-)Y{65c;ywYiAh-1*hZcToLHK ztpl1xomJ+Yb}K(cfbJr2=GNOnT!UFA7Vy~fBz8?J>XHsbZoDad^8PxfSa0GDgENZS zuLCEqzb*xWX2CG*b&5IiO#NzrW*;`VC9455M`o1NBh+(k8~`XCEEoC1Ybwf;vr4K3 zg|EB<07?SOqHp9DhLpS&bzgo70I+ghB_#)K7H%AMU3v}xuyQq9&Bm~++VYhF09a+U zl7>n7Jjm$K#b*FONz~fj;I->Bf;ule1prFN9FovcDGBkpg>)O*-}eLnC{6oZHZ$o% zXKW$;0_{8hxHQ>l;_*HATI(`7t#^{$(zLe}h*mqwOc*nRY9=?Sx4OOeVIfI|0V(V2 zBrW#G7Ss9wvzr@>H*`r>zE z+e8bOBgqIgldUJlG(YUDviMB`9+DH8n-s9SXRLyJHO1!=wY^79WYZMTa(wiZ!zP66 zA~!21vmF3H2{ngD;+`6j#~6j;$*f*G_2ZD1E;9(yaw7d-QnSCpK(cR1zU3qU0000< KMNUMnLSTYoA~SLT literal 0 HcmV?d00001 diff --git a/docs/html/bdwn.png b/docs/html/bdwn.png new file mode 100644 index 0000000000000000000000000000000000000000..940a0b950443a0bb1b216ac03c45b8a16c955452 GIT binary patch literal 147 zcmeAS@N?(olHy`uVBq!ia0vp^>_E)H!3HEvS)PKZC{Gv1kP61Pb5HX&C2wk~_T + + + + + + +Vulk: TypeChecker< T > Class Template Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + +
+
+
TypeChecker< T > Class Template Reference
+
+
+

Detailed Description

+
template<typename T>
+class TypeChecker< T >

Forces a compile error and shows the type of a variable. Useful tool when searching for an auto type or deep library calls. Inspired from Scott Meyers' Effective C++ book.

Template Parameters
+ + +
TType you are looking for, use decltype of the variable to detect it.
+
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classes.html b/docs/html/classes.html new file mode 100644 index 0000000..c95af1b --- /dev/null +++ b/docs/html/classes.html @@ -0,0 +1,90 @@ + + + + + + + +Vulk: Class Index + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + +
+
+
Class Index
+
+
+
C | E | F | G | K | M | R | S | T | U | V | W
+
+
+
C
+
ContextGLFW (vulk)
ContextVulkan (vulk)
+
+
E
+
Exception (vulk)
+
+
F
+
FrameManager (vulk)
+
+
G
+
GLFWException (vulk)
+
+
K
+
Keyboard (vulk)
+
+
M
+
Mat3 (vulk)
Mouse (vulk)
+
+
R
+
Rect (vulk)
+
+
S
+
ScopedProfiler (vulk::utils)
Shader (vulk)
+
+
T
+
TypeChecker
+
+
U
+
UniformBufferObject
+
+
V
+
Vec2 (vulk)
Vec3 (vulk)
Vertex
VulkanException (vulk)
+
+
W
+
Window (vulk)
+
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_context_g_l_f_w-members.html b/docs/html/classvulk_1_1_context_g_l_f_w-members.html new file mode 100644 index 0000000..aeaa513 --- /dev/null +++ b/docs/html/classvulk_1_1_context_g_l_f_w-members.html @@ -0,0 +1,61 @@ + + + + + + + +Vulk: Member List + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
vulk::ContextGLFW Member List
+
+
+ +

This is the complete list of members for vulk::ContextGLFW, including all inherited members.

+ + + + +
ensureInstance()vulk::ContextGLFWinlinestatic
getInstance()vulk::ContextGLFWstatic
~ContextGLFW()vulk::ContextGLFW
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_context_g_l_f_w.html b/docs/html/classvulk_1_1_context_g_l_f_w.html new file mode 100644 index 0000000..2fdf9f6 --- /dev/null +++ b/docs/html/classvulk_1_1_context_g_l_f_w.html @@ -0,0 +1,147 @@ + + + + + + + +Vulk: vulk::ContextGLFW Class Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
vulk::ContextGLFW Class Reference
+
+
+ +

#include <ContextGLFW.hpp>

+ + + + +

+Public Member Functions

 ~ContextGLFW ()
 
+ + + + + +

+Static Public Member Functions

static ContextGLFW & getInstance ()
 
static void ensureInstance ()
 
+

Constructor & Destructor Documentation

+ +

◆ ~ContextGLFW()

+ +
+
+ + + + + + + +
vulk::ContextGLFW::~ContextGLFW ()
+
+ +
+
+

Member Function Documentation

+ +

◆ ensureInstance()

+ +
+
+ + + + + +
+ + + + + + + +
static void vulk::ContextGLFW::ensureInstance ()
+ 		+inlinestatic
+
+

Makes sure a valid GLFW context is created

+ +
+
+ +

◆ getInstance()

+ +
+
+ + + + + +
+ + + + + + + +
static ContextGLFW & vulk::ContextGLFW::getInstance ()
+ 		+static
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_context_vulkan-members.html b/docs/html/classvulk_1_1_context_vulkan-members.html new file mode 100644 index 0000000..e77a328 --- /dev/null +++ b/docs/html/classvulk_1_1_context_vulkan-members.html @@ -0,0 +1,63 @@ + + + + + + + +Vulk: Member List + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
vulk::ContextVulkan Member List
+
+
+ +

This is the complete list of members for vulk::ContextVulkan, including all inherited members.

+ + + + + + +
createInstance(GLFWwindow *windowHandle)vulk::ContextVulkanstatic
draw()vulk::ContextVulkan
getInstance()vulk::ContextVulkanstatic
setFrameBufferResized(bool value) noexceptvulk::ContextVulkaninline
~ContextVulkan()vulk::ContextVulkan
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_context_vulkan.html b/docs/html/classvulk_1_1_context_vulkan.html new file mode 100644 index 0000000..1e6e6f3 --- /dev/null +++ b/docs/html/classvulk_1_1_context_vulkan.html @@ -0,0 +1,196 @@ + + + + + + + +Vulk: vulk::ContextVulkan Class Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Classes | +Public Member Functions | +Static Public Member Functions | +List of all members
+
vulk::ContextVulkan Class Reference
+
+
+ +

#include <ContextVulkan.hpp>

+ + + + + + + + +

+Public Member Functions

 ~ContextVulkan ()
 
void draw ()
 
void setFrameBufferResized (bool value) noexcept
 
+ + + + + +

+Static Public Member Functions

static void createInstance (GLFWwindow *windowHandle)
 
static ContextVulkan & getInstance ()
 
+

Constructor & Destructor Documentation

+ +

◆ ~ContextVulkan()

+ +
+
+ + + + + + + +
vulk::ContextVulkan::~ContextVulkan ()
+
+ +
+
+

Member Function Documentation

+ +

◆ createInstance()

+ +
+
+ + + + + +
+ + + + + + + + +
static void vulk::ContextVulkan::createInstance (GLFWwindow * windowHandle)
+ 		+static
+
+ +
+
+ +

◆ draw()

+ +
+
+ + + + + + + +
void vulk::ContextVulkan::draw ()
+
+

TODO: This should not be public. The Vulkan context should only be exposed to the window. Calling this function from the static getInstance().draw() can break stuff.

+ +
+
+ +

◆ getInstance()

+ +
+
+ + + + + +
+ + + + + + + +
static ContextVulkan & vulk::ContextVulkan::getInstance ()
+ 		+static
+
+ +
+
+ +

◆ setFrameBufferResized()

+ +
+
+ + + + + +
+ + + + + + + + +
void vulk::ContextVulkan::setFrameBufferResized (bool value)
+ 		+inlinenoexcept
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_exception-members.html b/docs/html/classvulk_1_1_exception-members.html new file mode 100644 index 0000000..0da8cbc --- /dev/null +++ b/docs/html/classvulk_1_1_exception-members.html @@ -0,0 +1,63 @@ + + + + + + + +Vulk: Member List + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
vulk::Exception Member List
+
+
+ +

This is the complete list of members for vulk::Exception, including all inherited members.

+ + + + + + +
Exception()vulk::Exceptioninline
Exception(const char *message, const char *category="vulk::Exception")vulk::Exceptioninlineexplicit
Exception(const std::string &message, const std::string &category="vulk::Exception")vulk::Exceptioninlineexplicit
m_whatvulk::Exceptionprotected
what() const noexcept overridevulk::Exceptioninline
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_exception.html b/docs/html/classvulk_1_1_exception.html new file mode 100644 index 0000000..13750dc --- /dev/null +++ b/docs/html/classvulk_1_1_exception.html @@ -0,0 +1,234 @@ + + + + + + + +Vulk: vulk::Exception Class Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Protected Attributes | +List of all members
+
vulk::Exception Class Reference
+
+
+ +

#include <Exceptions.hpp>

+
+Inheritance diagram for vulk::Exception:
+
+
+ +
+ + + + + + + + + + +

+Public Member Functions

 Exception ()
 
 Exception (const char *message, const char *category="vulk::Exception")
 
 Exception (const std::string &message, const std::string &category="vulk::Exception")
 
const char * what () const noexcept override
 
+ + + +

+Protected Attributes

std::string m_what
 
+

Constructor & Destructor Documentation

+ +

◆ Exception() [1/3]

+ +
+
+ + + + + +
+ + + + + + + +
vulk::Exception::Exception ()
+ 		+inline
+
+ +
+
+ +

◆ Exception() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
vulk::Exception::Exception (const char * message,
const char * category = "vulk::Exception" 
)
+ 		+inlineexplicit
+
+ +
+
+ +

◆ Exception() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
vulk::Exception::Exception (const std::string & message,
const std::string & category = "vulk::Exception" 
)
+ 		+inlineexplicit
+
+ +
+
+

Member Function Documentation

+ +

◆ what()

+ +
+
+ + + + + +
+ + + + + + + +
const char * vulk::Exception::what () const
+ 		+inlineoverridenoexcept
+
+ +
+
+

Member Data Documentation

+ +

◆ m_what

+ +
+
+ + + + + +
+ + + + +
std::string vulk::Exception::m_what
+ 		+protected
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_exception.png b/docs/html/classvulk_1_1_exception.png new file mode 100644 index 0000000000000000000000000000000000000000..dacc4cf978a54ef174f6fa5f68aa04c3a688b5c6 GIT binary patch literal 475 zcmeAS@N?(olHy`uVBq!ia0vp^2|ygc!3-oX+B7T&QW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;KeVXlAXZfCI!%6+TT@SX^8~)zo>VDwQZRSbk z(i^((^6wR?*LWgzV9BO3-BZr{44TWjuZ3@EF^{|W>6w^*&P0{i>#cX<**$`snH4-2 z+A$g!zt(7ou44ESl7Haw#hDkR4Qlu6FSLFjzh@C6Lx(8?!$LL&g)0mUEm8~(0n7{n zSquzLe-#dZoZe6e61&gjv+VolY6gqTdXM!O6s|>{;F_`h&&@5BZQYeWSI*kv8-L>3 z>nD5E5}1oy-#YRBDT-r$&=r?H;l22^m~C%)u1Q~KXnhhS{H3;G_U( + + + + + + +Vulk: Member List + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
vulk::FrameManager Member List
+
+
+ +

This is the complete list of members for vulk::FrameManager, including all inherited members.

+ + + + + + + + + + +
FrameManager()vulk::FrameManager
FramerateStringBuffer typedefvulk::FrameManager
getDeltaTime() const noexceptvulk::FrameManagerinline
getFPS() const noexceptvulk::FrameManagerinline
getFramerateCString() const noexceptvulk::FrameManager
getFramerateString() const noexceptvulk::FrameManager
OnSecondCallback typedefvulk::FrameManager
setOnSecondCallback(const OnSecondCallback &func) noexceptvulk::FrameManagerinline
update() noexceptvulk::FrameManager
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_frame_manager.html b/docs/html/classvulk_1_1_frame_manager.html new file mode 100644 index 0000000..ddf9592 --- /dev/null +++ b/docs/html/classvulk_1_1_frame_manager.html @@ -0,0 +1,288 @@ + + + + + + + +Vulk: vulk::FrameManager Class Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Public Types | +Public Member Functions | +List of all members
+
vulk::FrameManager Class Referencefinal
+
+
+ +

#include <FrameManager.hpp>

+ + + + + + +

+Public Types

using OnSecondCallback = std::function< void(const FrameManager &frameManager)>
 
using FramerateStringBuffer = std::array< char, 16 >
 
+ + + + + + + + + + + + + + + +

+Public Member Functions

 FrameManager ()
 
void update () noexcept
 
void setOnSecondCallback (const OnSecondCallback &func) noexcept
 
auto getDeltaTime () const noexcept
 
auto getFPS () const noexcept
 
FramerateStringBuffer getFramerateCString () const noexcept
 
std::string getFramerateString () const noexcept
 
+

Member Typedef Documentation

+ +

◆ FramerateStringBuffer

+ +
+
+ + + + +
using vulk::FrameManager::FramerateStringBuffer = std::array<char, 16>
+
+ +
+
+ +

◆ OnSecondCallback

+ +
+
+ + + + +
using vulk::FrameManager::OnSecondCallback = std::function<void(const FrameManager& frameManager)>
+
+ +
+
+

Constructor & Destructor Documentation

+ +

◆ FrameManager()

+ +
+
+ + + + + + + +
vulk::FrameManager::FrameManager ()
+
+ +
+
+

Member Function Documentation

+ +

◆ getDeltaTime()

+ +
+
+ + + + + +
+ + + + + + + +
auto vulk::FrameManager::getDeltaTime () const
+ 		+inlinenoexcept
+
+ +
+
+ +

◆ getFPS()

+ +
+
+ + + + + +
+ + + + + + + +
auto vulk::FrameManager::getFPS () const
+ 		+inlinenoexcept
+
+ +
+
+ +

◆ getFramerateCString()

+ +
+
+ + + + + +
+ + + + + + + +
FramerateStringBuffer vulk::FrameManager::getFramerateCString () const
+ 		+noexcept
+
+ +
+
+ +

◆ getFramerateString()

+ +
+
+ + + + + +
+ + + + + + + +
std::string vulk::FrameManager::getFramerateString () const
+ 		+noexcept
+
+ +
+
+ +

◆ setOnSecondCallback()

+ +
+
+ + + + + +
+ + + + + + + + +
void vulk::FrameManager::setOnSecondCallback (const OnSecondCallback & func)
+ 		+inlinenoexcept
+
+ +
+
+ +

◆ update()

+ +
+
+ + + + + +
+ + + + + + + +
void vulk::FrameManager::update ()
+ 		+noexcept
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_g_l_f_w_exception-members.html b/docs/html/classvulk_1_1_g_l_f_w_exception-members.html new file mode 100644 index 0000000..73ad2d6 --- /dev/null +++ b/docs/html/classvulk_1_1_g_l_f_w_exception-members.html @@ -0,0 +1,60 @@ + + + + + + + +Vulk: Member List + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
vulk::GLFWException Member List
+
+
+ +

This is the complete list of members for vulk::GLFWException, including all inherited members.

+ + + +
getGLFWError() noexceptvulk::GLFWExceptionstatic
GLFWException(const std::string &message=getGLFWError())vulk::GLFWExceptioninlineexplicit
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_g_l_f_w_exception.html b/docs/html/classvulk_1_1_g_l_f_w_exception.html new file mode 100644 index 0000000..5e34903 --- /dev/null +++ b/docs/html/classvulk_1_1_g_l_f_w_exception.html @@ -0,0 +1,134 @@ + + + + + + + +Vulk: vulk::GLFWException Class Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
vulk::GLFWException Class Reference
+
+
+ +

#include <Exceptions.hpp>

+
+Inheritance diagram for vulk::GLFWException:
+
+
+ +
+ + + + +

+Public Member Functions

 GLFWException (const std::string &message=getGLFWError())
 
+ + + +

+Static Public Member Functions

static std::string getGLFWError () noexcept
 
+

Constructor & Destructor Documentation

+ +

◆ GLFWException()

+ +
+
+ + + + + +
+ + + + + + + + +
vulk::GLFWException::GLFWException (const std::string & message = getGLFWError())
+ 		+inlineexplicit
+
+ +
+
+

Member Function Documentation

+ +

◆ getGLFWError()

+ +
+
+ + + + + +
+ + + + + + + +
static std::string vulk::GLFWException::getGLFWError ()
+ 		+staticnoexcept
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_g_l_f_w_exception.png b/docs/html/classvulk_1_1_g_l_f_w_exception.png new file mode 100644 index 0000000000000000000000000000000000000000..2523a4c53a0941ca99969eba78589b599c626e93 GIT binary patch literal 569 zcmeAS@N?(olHy`uVBq!ia0vp^%|IN$!3+|4X?7JzNd)+Wxc>kDAIN<1=4)yHp$R}1 z7#}!rfVK0EJdn##666=m08|75S5Ji)F)%Qm@N{tusbG9NH+E8s0#A#z{^jrcKdy4{ z2vIxtE+Qg&&-*Gj*QZp7GvHcwz7|o#(bQ|2DJJ3=Hp0UoGNETNQMp^7~Z7=0nrwYKzSw!9}CYFw!J~{~oD}!rZx0}U;hl^*_8hfmJ{;uvqDZj+IKM9h%s>|>F z + + + + + + +Vulk: Member List + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
vulk::Keyboard Member List
+
+
+ +

This is the complete list of members for vulk::Keyboard, including all inherited members.

+ + + + + + +
getKeyboard(GLFWwindow *window)vulk::Keyboardinlinestatic
isKeyDown(vulk::Key key) const noexceptvulk::Keyboardinline
Keyboard(GLFWwindow *window)vulk::Keyboardexplicit
onKeyPressed(int scancode, int action)vulk::Keyboard
~Keyboard()vulk::Keyboard
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_keyboard.html b/docs/html/classvulk_1_1_keyboard.html new file mode 100644 index 0000000..98f2efe --- /dev/null +++ b/docs/html/classvulk_1_1_keyboard.html @@ -0,0 +1,206 @@ + + + + + + + +Vulk: vulk::Keyboard Class Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
vulk::Keyboard Class Referencefinal
+
+
+ +

#include <Keyboard.hpp>

+ + + + + + + + + + +

+Public Member Functions

 Keyboard (GLFWwindow *window)
 
 ~Keyboard ()
 
bool isKeyDown (vulk::Key key) const noexcept
 
void onKeyPressed (int scancode, int action)
 
+ + + +

+Static Public Member Functions

static Keyboard * getKeyboard (GLFWwindow *window)
 
+

Constructor & Destructor Documentation

+ +

◆ Keyboard()

+ +
+
+ + + + + +
+ + + + + + + + +
vulk::Keyboard::Keyboard (GLFWwindow * window)
+ 		+explicit
+
+ +
+
+ +

◆ ~Keyboard()

+ +
+
+ + + + + + + +
vulk::Keyboard::~Keyboard ()
+
+ +
+
+

Member Function Documentation

+ +

◆ getKeyboard()

+ +
+
+ + + + + +
+ + + + + + + + +
static Keyboard * vulk::Keyboard::getKeyboard (GLFWwindow * window)
+ 		+inlinestatic
+
+ +
+
+ +

◆ isKeyDown()

+ +
+
+ + + + + +
+ + + + + + + + +
bool vulk::Keyboard::isKeyDown (vulk::Key key) const
+ 		+inlinenoexcept
+
+ +
+
+ +

◆ onKeyPressed()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void vulk::Keyboard::onKeyPressed (int scancode,
int action 
)
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_mouse-members.html b/docs/html/classvulk_1_1_mouse-members.html new file mode 100644 index 0000000..09f1137 --- /dev/null +++ b/docs/html/classvulk_1_1_mouse-members.html @@ -0,0 +1,63 @@ + + + + + + + +Vulk: Member List + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
vulk::Mouse Member List
+
+
+ +

This is the complete list of members for vulk::Mouse, including all inherited members.

+ + + + + + +
getMouse(GLFWwindow *window)vulk::Mouseinlinestatic
isButtonDown(vulk::Buttons button) const noexceptvulk::Mouseinline
Mouse(GLFWwindow *window)vulk::Mouseexplicit
onButtonPressed(int button, int action)vulk::Mouse
~Mouse()vulk::Mouse
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_mouse.html b/docs/html/classvulk_1_1_mouse.html new file mode 100644 index 0000000..35fc71a --- /dev/null +++ b/docs/html/classvulk_1_1_mouse.html @@ -0,0 +1,206 @@ + + + + + + + +Vulk: vulk::Mouse Class Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
vulk::Mouse Class Referencefinal
+
+
+ +

#include <Mouse.hpp>

+ + + + + + + + + + +

+Public Member Functions

 Mouse (GLFWwindow *window)
 
 ~Mouse ()
 
bool isButtonDown (vulk::Buttons button) const noexcept
 
void onButtonPressed (int button, int action)
 
+ + + +

+Static Public Member Functions

static Mouse * getMouse (GLFWwindow *window)
 
+

Constructor & Destructor Documentation

+ +

◆ Mouse()

+ +
+
+ + + + + +
+ + + + + + + + +
vulk::Mouse::Mouse (GLFWwindow * window)
+ 		+explicit
+
+ +
+
+ +

◆ ~Mouse()

+ +
+
+ + + + + + + +
vulk::Mouse::~Mouse ()
+
+ +
+
+

Member Function Documentation

+ +

◆ getMouse()

+ +
+
+ + + + + +
+ + + + + + + + +
static Mouse * vulk::Mouse::getMouse (GLFWwindow * window)
+ 		+inlinestatic
+
+ +
+
+ +

◆ isButtonDown()

+ +
+
+ + + + + +
+ + + + + + + + +
bool vulk::Mouse::isButtonDown (vulk::Buttons button) const
+ 		+inlinenoexcept
+
+ +
+
+ +

◆ onButtonPressed()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void vulk::Mouse::onButtonPressed (int button,
int action 
)
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_shader-members.html b/docs/html/classvulk_1_1_shader-members.html new file mode 100644 index 0000000..0e433d6 --- /dev/null +++ b/docs/html/classvulk_1_1_shader-members.html @@ -0,0 +1,62 @@ + + + + + + + +Vulk: Member List + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
vulk::Shader Member List
+
+
+ +

This is the complete list of members for vulk::Shader, including all inherited members.

+ + + + + +
getShaderStageCreateInfo() const noexceptvulk::Shaderinline
Shader(vk::Device &device, const char *filePath, Type type)vulk::Shader
Type typedefvulk::Shader
~Shader()vulk::Shader
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_shader.html b/docs/html/classvulk_1_1_shader.html new file mode 100644 index 0000000..eb9b40e --- /dev/null +++ b/docs/html/classvulk_1_1_shader.html @@ -0,0 +1,172 @@ + + + + + + + +Vulk: vulk::Shader Class Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Public Types | +Public Member Functions | +List of all members
+
vulk::Shader Class Reference
+
+
+ +

#include <Shader.hpp>

+ + + + +

+Public Types

using Type = vk::ShaderStageFlagBits
 
+ + + + + + + +

+Public Member Functions

 Shader (vk::Device &device, const char *filePath, Type type)
 
 ~Shader ()
 
const vk::PipelineShaderStageCreateInfo & getShaderStageCreateInfo () const noexcept
 
+

Member Typedef Documentation

+ +

◆ Type

+ +
+
+ + + + +
using vulk::Shader::Type = vk::ShaderStageFlagBits
+
+ +
+
+

Constructor & Destructor Documentation

+ +

◆ Shader()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
vulk::Shader::Shader (vk::Device & device,
const char * filePath,
Type type 
)
+
+ +
+
+ +

◆ ~Shader()

+ +
+
+ + + + + + + +
vulk::Shader::~Shader ()
+
+ +
+
+

Member Function Documentation

+ +

◆ getShaderStageCreateInfo()

+ +
+
+ + + + + +
+ + + + + + + +
const vk::PipelineShaderStageCreateInfo & vulk::Shader::getShaderStageCreateInfo () const
+ 		+inlinenoexcept
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_vulkan_exception-members.html b/docs/html/classvulk_1_1_vulkan_exception-members.html new file mode 100644 index 0000000..aa37fb9 --- /dev/null +++ b/docs/html/classvulk_1_1_vulkan_exception-members.html @@ -0,0 +1,61 @@ + + + + + + + +Vulk: Member List + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
vulk::VulkanException Member List
+
+
+ +

This is the complete list of members for vulk::VulkanException, including all inherited members.

+ + + + +
VulkanException(vk::Result result)vulk::VulkanExceptionexplicit
VulkanException(const char *what)vulk::VulkanExceptionexplicit
VulkanException(const std::string &what)vulk::VulkanExceptionexplicit
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_vulkan_exception.html b/docs/html/classvulk_1_1_vulkan_exception.html new file mode 100644 index 0000000..31f9051 --- /dev/null +++ b/docs/html/classvulk_1_1_vulkan_exception.html @@ -0,0 +1,158 @@ + + + + + + + +Vulk: vulk::VulkanException Class Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Public Member Functions | +List of all members
+
vulk::VulkanException Class Reference
+
+
+ +

#include <Exceptions.hpp>

+
+Inheritance diagram for vulk::VulkanException:
+
+
+ +
+ + + + + + + + +

+Public Member Functions

 VulkanException (vk::Result result)
 
 VulkanException (const char *what)
 
 VulkanException (const std::string &what)
 
+

Constructor & Destructor Documentation

+ +

◆ VulkanException() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + +
vulk::VulkanException::VulkanException (vk::Result result)
+ 		+explicit
+
+ +
+
+ +

◆ VulkanException() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + +
vulk::VulkanException::VulkanException (const char * what)
+ 		+explicit
+
+ +
+
+ +

◆ VulkanException() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + +
vulk::VulkanException::VulkanException (const std::string & what)
+ 		+explicit
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_vulkan_exception.png b/docs/html/classvulk_1_1_vulkan_exception.png new file mode 100644 index 0000000000000000000000000000000000000000..c269760c5da13ec738e3571853885754bb2e5828 GIT binary patch literal 600 zcmeAS@N?(olHy`uVBq!ia0vp^?LZvB!3-o>n5L}ue4aedqW|BufW zamtxAC2jk6v9&s~;#obC2ez!AG1E6;hDz<-NzRjki#&>~p0C)qR5D;%)bu6Z(&~~$ zE%Q`l-^>+N$;^2CS>tx>t>^Ey|GRawJnF9QgPT)UX8-?r_NU6q&5G`^YqoCO@2eO4 z{Lb=Y3s*;1Ew?kf?KWrYuNAw$8deuOOj(k#-C~=me-T@s(D!7Si7V}wt&6fdTX;~& za?$h9+B;7&)OYWn9`!l*_S5r;}y5o7u39IH~F8h z`ZD39;>k=UKI6^rr4Q`C#hk!2yXEo68O$j{eXPk`6Cy1>?PYL0$!MX<{$PqsLvRs; zA9l{=`lE?yW{rsq@!Ov;%$dYouGe&56V;CaplAD~};)^me=W+K==^XB)r Z{A)V=<=gIi>;fhO22WQ%mvv4FO#okE9ykC1 literal 0 HcmV?d00001 diff --git a/docs/html/classvulk_1_1_window-members.html b/docs/html/classvulk_1_1_window-members.html new file mode 100644 index 0000000..e1ee720 --- /dev/null +++ b/docs/html/classvulk_1_1_window-members.html @@ -0,0 +1,71 @@ + + + + + + + +Vulk: Member List + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
vulk::Window Member List
+
+
+ +

This is the complete list of members for vulk::Window, including all inherited members.

+ + + + + + + + + + + + + + +
close() noexceptvulk::Window
display()vulk::Window
getFrameManager() noexceptvulk::Windowinline
getFrameManager() const noexceptvulk::Windowinline
isOpen() const noexceptvulk::Window
operator=(Window &&rhs) noexceptvulk::Window
operator=(const Window &)=deletevulk::Window
pollEvents()vulk::Window
setTitle(const char *newTitle) noexceptvulk::Window
Window(unsigned int width, unsigned int height, const char *title)vulk::Window
Window(Window &&rhs) noexceptvulk::Window
Window(const Window &)=deletevulk::Window
~Window()vulk::Window
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1_window.html b/docs/html/classvulk_1_1_window.html new file mode 100644 index 0000000..69d6180 --- /dev/null +++ b/docs/html/classvulk_1_1_window.html @@ -0,0 +1,461 @@ + + + + + + + +Vulk: vulk::Window Class Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Public Member Functions | +List of all members
+
vulk::Window Class Reference
+
+
+ +

#include <Window.hpp>

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Window (unsigned int width, unsigned int height, const char *title)
 Construct a new Window object. More...
 
 ~Window ()
 Destroy the Window object. More...
 
 Window (Window &&rhs) noexcept
 Construct a new Window object. More...
 
Window & operator= (Window &&rhs) noexcept
 
 Window (const Window &)=delete
 
Window & operator= (const Window &)=delete
 
void display ()
 
void pollEvents ()
 
void close () noexcept
 
void setTitle (const char *newTitle) noexcept
 Changes the title of the window. More...
 
bool isOpen () const noexcept
 
FrameManager & getFrameManager () noexcept
 Get the Frame Manager object. More...
 
const FrameManager & getFrameManager () const noexcept
 Get the Frame Manager object. More...
 
+

Constructor & Destructor Documentation

+ +

◆ Window() [1/3]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
vulk::Window::Window (unsigned int width,
unsigned int height,
const char * title 
)
+
+ +

Construct a new Window object.

+
Parameters
+ + + + +
width
height
title
+
+
+ +
+
+ +

◆ ~Window()

+ +
+
+ + + + + + + +
vulk::Window::~Window ()
+
+ +

Destroy the Window object.

+ +
+
+ +

◆ Window() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + +
vulk::Window::Window (Window && rhs)
+ 		+noexcept
+
+ +

Construct a new Window object.

+
Parameters
+ + +
rhs
+
+
+ +
+
+ +

◆ Window() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + +
vulk::Window::Window (const Window & )
+ 		+delete
+
+ +
+
+

Member Function Documentation

+ +

◆ close()

+ +
+
+ + + + + +
+ + + + + + + +
void vulk::Window::close ()
+ 		+noexcept
+
+ +
+
+ +

◆ display()

+ +
+
+ + + + + + + +
void vulk::Window::display ()
+
+ +
+
+ +

◆ getFrameManager() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
const FrameManager & vulk::Window::getFrameManager () const
+ 		+inlinenoexcept
+
+ +

Get the Frame Manager object.

+
Returns
const FrameManager&
+ +
+
+ +

◆ getFrameManager() [2/2]

+ +
+
+ + + + + +
+ + + + + + + +
FrameManager & vulk::Window::getFrameManager ()
+ 		+inlinenoexcept
+
+ +

Get the Frame Manager object.

+
Returns
FrameManager&
+ +
+
+ +

◆ isOpen()

+ +
+
+ + + + + +
+ + + + + + + +
bool vulk::Window::isOpen () const
+ 		+noexcept
+
+
Returns
true
+
+false
+ +
+
+ +

◆ operator=() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
Window & vulk::Window::operator= (const Window & )
+ 		+delete
+
+ +
+
+ +

◆ operator=() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
Window & vulk::Window::operator= (Window && rhs)
+ 		+noexcept
+
+
Parameters
+ + +
rhs
+
+
+
Returns
Window&
+ +
+
+ +

◆ pollEvents()

+ +
+
+ + + + + + + +
void vulk::Window::pollEvents ()
+
+ +
+
+ +

◆ setTitle()

+ +
+
+ + + + + +
+ + + + + + + + +
void vulk::Window::setTitle (const char * newTitle)
+ 		+noexcept
+
+ +

Changes the title of the window.

+
Parameters
+ + +
newTitleThe new window title, ignored if null.
+
+
+
Note
This will be updated on the next pollEvents() call.
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1utils_1_1_scoped_profiler-members.html b/docs/html/classvulk_1_1utils_1_1_scoped_profiler-members.html new file mode 100644 index 0000000..c0589e1 --- /dev/null +++ b/docs/html/classvulk_1_1utils_1_1_scoped_profiler-members.html @@ -0,0 +1,68 @@ + + + + + + + +Vulk: Member List + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
vulk::utils::ScopedProfiler Member List
+
+
+ +

This is the complete list of members for vulk::utils::ScopedProfiler, including all inherited members.

+ + + + + + + + + + + +
Clock typedefvulk::utils::ScopedProfiler
DurationMillis typedefvulk::utils::ScopedProfiler
DurationSeconds typedefvulk::utils::ScopedProfiler
operator=(ScopedProfiler &&)=deletevulk::utils::ScopedProfiler
operator=(const ScopedProfiler &)=deletevulk::utils::ScopedProfiler
ScopedProfiler(const char *name) noexceptvulk::utils::ScopedProfilerexplicit
ScopedProfiler(ScopedProfiler &&)=deletevulk::utils::ScopedProfiler
ScopedProfiler(const ScopedProfiler &)=deletevulk::utils::ScopedProfiler
TimePoint typedefvulk::utils::ScopedProfiler
~ScopedProfiler()vulk::utils::ScopedProfiler
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/classvulk_1_1utils_1_1_scoped_profiler.html b/docs/html/classvulk_1_1utils_1_1_scoped_profiler.html new file mode 100644 index 0000000..4a20d93 --- /dev/null +++ b/docs/html/classvulk_1_1utils_1_1_scoped_profiler.html @@ -0,0 +1,297 @@ + + + + + + + +Vulk: vulk::utils::ScopedProfiler Class Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
+Public Types | +Public Member Functions | +List of all members
+
vulk::utils::ScopedProfiler Class Referencefinal
+
+
+ +

#include <ScopedProfiler.hpp>

+ + + + + + + + + + +

+Public Types

using Clock = std::chrono::high_resolution_clock
 
using TimePoint = decltype(Clock::now())
 
using DurationSeconds = std::chrono::duration< double >
 
using DurationMillis = std::chrono::duration< double, std::milli >
 
+ + + + + + + + + + + + + +

+Public Member Functions

 ScopedProfiler (const char *name) noexcept
 
 ~ScopedProfiler ()
 
 ScopedProfiler (ScopedProfiler &&)=delete
 
 ScopedProfiler (const ScopedProfiler &)=delete
 
ScopedProfiler & operator= (ScopedProfiler &&)=delete
 
ScopedProfiler & operator= (const ScopedProfiler &)=delete
 
+

Member Typedef Documentation

+ +

◆ Clock

+ +
+
+ + + + +
using vulk::utils::ScopedProfiler::Clock = std::chrono::high_resolution_clock
+
+ +
+
+ +

◆ DurationMillis

+ +
+
+ + + + +
using vulk::utils::ScopedProfiler::DurationMillis = std::chrono::duration<double, std::milli>
+
+ +
+
+ +

◆ DurationSeconds

+ +
+
+ + + + +
using vulk::utils::ScopedProfiler::DurationSeconds = std::chrono::duration<double>
+
+ +
+
+ +

◆ TimePoint

+ +
+
+ + + + +
using vulk::utils::ScopedProfiler::TimePoint = decltype(Clock::now())
+
+ +
+
+

Constructor & Destructor Documentation

+ +

◆ ScopedProfiler() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + +
vulk::utils::ScopedProfiler::ScopedProfiler (const char * name)
+ 		+explicitnoexcept
+
+ +
+
+ +

◆ ~ScopedProfiler()

+ +
+
+ + + + + + + +
vulk::utils::ScopedProfiler::~ScopedProfiler ()
+
+ +
+
+ +

◆ ScopedProfiler() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + +
vulk::utils::ScopedProfiler::ScopedProfiler (ScopedProfiler && )
+ 		+delete
+
+ +
+
+ +

◆ ScopedProfiler() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + +
vulk::utils::ScopedProfiler::ScopedProfiler (const ScopedProfiler & )
+ 		+delete
+
+ +
+
+

Member Function Documentation

+ +

◆ operator=() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
ScopedProfiler & vulk::utils::ScopedProfiler::operator= (const ScopedProfiler & )
+ 		+delete
+
+ +
+
+ +

◆ operator=() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
ScopedProfiler & vulk::utils::ScopedProfiler::operator= (ScopedProfiler && )
+ 		+delete
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/closed.png b/docs/html/closed.png new file mode 100644 index 0000000000000000000000000000000000000000..98cc2c909da37a6df914fbf67780eebd99c597f5 GIT binary patch literal 132 zcmeAS@N?(olHy`uVBq!ia0vp^oFL4>1|%O$WD@{V-kvUwAr*{o@8{^CZMh(5KoB^r_<4^zF@3)Cp&&t3hdujKf f*?bjBoY!V+E))@{xMcbjXe@)LtDnm{r-UW|*e5JT literal 0 HcmV?d00001 diff --git a/docs/html/dir_5a30104352ef4255dc24354b02eb2d20.html b/docs/html/dir_5a30104352ef4255dc24354b02eb2d20.html new file mode 100644 index 0000000..2c3ce12 --- /dev/null +++ b/docs/html/dir_5a30104352ef4255dc24354b02eb2d20.html @@ -0,0 +1,61 @@ + + + + + + + +Vulk: lib/include Directory Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
include Directory Reference
+
+
+ + + + +

+Directories

directory  Vulk
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/dir_97aefd0d527b934f1d99a682da8fe6a9.html b/docs/html/dir_97aefd0d527b934f1d99a682da8fe6a9.html new file mode 100644 index 0000000..af2d9d8 --- /dev/null +++ b/docs/html/dir_97aefd0d527b934f1d99a682da8fe6a9.html @@ -0,0 +1,61 @@ + + + + + + + +Vulk: lib Directory Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
lib Directory Reference
+
+
+ + + + +

+Directories

directory  include
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/dir_b80377379080ab8697acea2877ef94f6.html b/docs/html/dir_b80377379080ab8697acea2877ef94f6.html new file mode 100644 index 0000000..9025ce5 --- /dev/null +++ b/docs/html/dir_b80377379080ab8697acea2877ef94f6.html @@ -0,0 +1,63 @@ + + + + + + + +Vulk: lib/include/Vulk/Contexts Directory Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
Contexts Directory Reference
+
+
+ + + + + + +

+Files

file  ContextGLFW.hpp [code]
 
file  ContextVulkan.hpp [code]
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/dir_bbfa40afa4c57c6dadf08b9016d8766e.html b/docs/html/dir_bbfa40afa4c57c6dadf08b9016d8766e.html new file mode 100644 index 0000000..a21d719 --- /dev/null +++ b/docs/html/dir_bbfa40afa4c57c6dadf08b9016d8766e.html @@ -0,0 +1,94 @@ + + + + + + + +Vulk: lib/include/Vulk Directory Reference + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + + +
+
+
Vulk Directory Reference
+
+
+ + + + +

+Directories

directory  Contexts
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Files

file  ClassUtils.hpp [code]
 
file  Exceptions.hpp [code]
 
file  FrameManager.hpp [code]
 
file  Keyboard.hpp [code]
 
file  Mat3.hpp [code]
 
file  Mouse.hpp [code]
 
file  Objects.hpp [code]
 
file  Rect.hpp [code]
 
file  ScopedProfiler.hpp [code]
 
file  Shader.hpp [code]
 
file  Time.hpp [code]
 
file  Utils.hpp [code]
 
file  Vec2.hpp [code]
 
file  Vec3.hpp [code]
 
file  Window.hpp [code]
 
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/doc.png b/docs/html/doc.png new file mode 100644 index 0000000000000000000000000000000000000000..17edabff95f7b8da13c9516a04efe05493c29501 GIT binary patch literal 746 zcmV7=@pnbNXRFEm&G8P!&WHG=d)>K?YZ1bzou)2{$)) zumDct!>4SyxL;zgaG>wy`^Hv*+}0kUfCrz~BCOViSb$_*&;{TGGn2^x9K*!Sf0=lV zpP=7O;GA0*Jm*tTYj$IoXvimpnV4S1Z5f$p*f$Db2iq2zrVGQUz~yq`ahn7ck(|CE z7Gz;%OP~J6)tEZWDzjhL9h2hdfoU2)Nd%T<5Kt;Y0XLt&<@6pQx!nw*5`@bq#?l*?3z{Hlzoc=Pr>oB5(9i6~_&-}A(4{Q$>c>%rV&E|a(r&;?i5cQB=} zYSDU5nXG)NS4HEs0it2AHe2>shCyr7`6@4*6{r@8fXRbTA?=IFVWAQJL&H5H{)DpM#{W(GL+Idzf^)uRV@oB8u$ z8v{MfJbTiiRg4bza<41NAzrl{=3fl_D+$t+^!xlQ8S}{UtY`e z;;&9UhyZqQRN%2pot{*Ei0*4~hSF_3AH2@fKU!$NSflS>{@tZpDT4`M2WRTTVH+D? z)GFlEGGHe?koB}i|1w45!BF}N_q&^HJ&-tyR{(afC6H7|aml|tBBbv}55C5DNP8p3 z)~jLEO4Z&2hZmP^i-e%(@d!(E|KRafiU8Q5u(wU((j8un3OR*Hvj+t literal 0 HcmV?d00001 diff --git a/docs/html/doxygen.css b/docs/html/doxygen.css new file mode 100644 index 0000000..9036737 --- /dev/null +++ b/docs/html/doxygen.css @@ -0,0 +1,1841 @@ +/* The standard CSS for doxygen 1.9.3 */ + +body, table, div, p, dl { + font: 400 14px/22px Roboto,sans-serif; +} + +p.reference, p.definition { + font: 400 14px/22px Roboto,sans-serif; +} + +/* @group Heading Levels */ + +h1.groupheader { + font-size: 150%; +} + +.title { + font: 400 14px/28px Roboto,sans-serif; + font-size: 150%; + font-weight: bold; + margin: 10px 2px; +} + +h2.groupheader { + border-bottom: 1px solid #879ECB; + color: #354C7B; + font-size: 150%; + font-weight: normal; + margin-top: 1.75em; + padding-top: 8px; + padding-bottom: 4px; + width: 100%; +} + +h3.groupheader { + font-size: 100%; +} + +h1, h2, h3, h4, h5, h6 { + -webkit-transition: text-shadow 0.5s linear; + -moz-transition: text-shadow 0.5s linear; + -ms-transition: text-shadow 0.5s linear; + -o-transition: text-shadow 0.5s linear; + transition: text-shadow 0.5s linear; + margin-right: 15px; +} + +h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { + text-shadow: 0 0 15px cyan; +} + +dt { + font-weight: bold; +} + +ul.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; + column-count: 3; +} + +p.startli, p.startdd { + margin-top: 2px; +} + +th p.starttd, th p.intertd, th p.endtd { + font-size: 100%; + font-weight: 700; +} + +p.starttd { + margin-top: 0px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +p.interli { +} + +p.interdd { +} + +p.intertd { +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.navtab { + border-right: 1px solid #A3B4D7; + padding-right: 15px; + text-align: right; + line-height: 110%; +} + +div.navtab table { + border-spacing: 0; +} + +td.navtab { + padding-right: 6px; + padding-left: 6px; +} +td.navtabHL { + background-image: url('tab_a.png'); + background-repeat:repeat-x; + padding-right: 6px; + padding-left: 6px; +} + +td.navtabHL a, td.navtabHL a:visited { + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +} + +a.navtab { + font-weight: bold; +} + +div.qindex{ + text-align: center; + width: 100%; + line-height: 140%; + font-size: 130%; + color: #A0A0A0; +} + +dt.alphachar{ + font-size: 180%; + font-weight: bold; +} + +.alphachar a{ + color: black; +} + +.alphachar a:hover, .alphachar a:visited{ + text-decoration: none; +} + +.classindex dl { + padding: 25px; + column-count:1 +} + +.classindex dd { + display:inline-block; + margin-left: 50px; + width: 90%; + line-height: 1.15em; +} + +.classindex dl.odd { + background-color: #F8F9FC; +} + +@media(min-width: 1120px) { + .classindex dl { + column-count:2 + } +} + +@media(min-width: 1320px) { + .classindex dl { + column-count:3 + } +} + + +/* @group Link Styling */ + +a { + color: #3D578C; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #4665A2; +} + +a:hover { + text-decoration: underline; +} + +.contents a.qindexHL:visited { + color: #FFFFFF; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code, a.code:visited, a.line, a.line:visited { + color: #4665A2; +} + +a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited { + color: #4665A2; +} + +a.code.hl_class { /* style for links to class names in code snippets */ } +a.code.hl_struct { /* style for links to struct names in code snippets */ } +a.code.hl_union { /* style for links to union names in code snippets */ } +a.code.hl_interface { /* style for links to interface names in code snippets */ } +a.code.hl_protocol { /* style for links to protocol names in code snippets */ } +a.code.hl_category { /* style for links to category names in code snippets */ } +a.code.hl_exception { /* style for links to exception names in code snippets */ } +a.code.hl_service { /* style for links to service names in code snippets */ } +a.code.hl_singleton { /* style for links to singleton names in code snippets */ } +a.code.hl_concept { /* style for links to concept names in code snippets */ } +a.code.hl_namespace { /* style for links to namespace names in code snippets */ } +a.code.hl_package { /* style for links to package names in code snippets */ } +a.code.hl_define { /* style for links to macro names in code snippets */ } +a.code.hl_function { /* style for links to function names in code snippets */ } +a.code.hl_variable { /* style for links to variable names in code snippets */ } +a.code.hl_typedef { /* style for links to typedef names in code snippets */ } +a.code.hl_enumvalue { /* style for links to enum value names in code snippets */ } +a.code.hl_enumeration { /* style for links to enumeration names in code snippets */ } +a.code.hl_signal { /* style for links to Qt signal names in code snippets */ } +a.code.hl_slot { /* style for links to Qt slot names in code snippets */ } +a.code.hl_friend { /* style for links to friend names in code snippets */ } +a.code.hl_dcop { /* style for links to KDE3 DCOP names in code snippets */ } +a.code.hl_property { /* style for links to property names in code snippets */ } +a.code.hl_event { /* style for links to event names in code snippets */ } +a.code.hl_sequence { /* style for links to sequence names in code snippets */ } +a.code.hl_dictionary { /* style for links to dictionary names in code snippets */ } + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +ul { + overflow: visible; +} + +#side-nav ul { + overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */ +} + +#main-nav ul { + overflow: visible; /* reset ul rule for the navigation bar drop down lists */ +} + +.fragment { + text-align: left; + direction: ltr; + overflow-x: auto; /*Fixed: fragment lines overlap floating elements*/ + overflow-y: hidden; +} + +pre.fragment { + border: 1px solid #C4CFE5; + background-color: #FBFCFD; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; + font-family: monospace, fixed; + font-size: 105%; +} + +div.fragment { + padding: 0 0 1px 0; /*Fixed: last line underline overlap border*/ + margin: 4px 8px 4px 2px; + background-color: #FBFCFD; + border: 1px solid #C4CFE5; +} + +div.line { + font-family: monospace, fixed; + font-size: 13px; + min-height: 13px; + line-height: 1.0; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + text-indent: -53px; + padding-left: 53px; + padding-bottom: 0px; + margin: 0px; + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +div.line:after { + content:"\000A"; + white-space: pre; +} + +div.line.glow { + background-color: cyan; + box-shadow: 0 0 10px cyan; +} + + +span.lineno { + padding-right: 4px; + margin-right: 9px; + text-align: right; + border-right: 2px solid #0F0; + background-color: #E8E8E8; + white-space: pre; +} +span.lineno a { + background-color: #D8D8D8; +} + +span.lineno a:hover { + background-color: #C8C8C8; +} + +.lineno { + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +div.ah, span.ah { + background-color: black; + font-weight: bold; + color: #FFFFFF; + margin-bottom: 3px; + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; + box-shadow: 2px 2px 3px #999; + -webkit-box-shadow: 2px 2px 3px #999; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); + background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000 110%); +} + +div.classindex ul { + list-style: none; + padding-left: 0; +} + +div.classindex span.ai { + display: inline-block; +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background-color: white; + color: black; + margin: 0; +} + +div.contents { + margin-top: 10px; + margin-left: 12px; + margin-right: 8px; +} + +td.indexkey { + background-color: #EBEFF6; + font-weight: bold; + border: 1px solid #C4CFE5; + margin: 2px 0px 2px 0; + padding: 2px 10px; + white-space: nowrap; + vertical-align: top; +} + +td.indexvalue { + background-color: #EBEFF6; + border: 1px solid #C4CFE5; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #EEF1F7; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl, img.inline { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +address.footer { + text-align: right; + padding-right: 12px; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +.compoundTemplParams { + color: #4665A2; + font-size: 80%; + line-height: 120%; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +blockquote { + background-color: #F7F8FB; + border-left: 2px solid #9CAFD4; + margin: 0 24px 0 4px; + padding: 0 12px 0 16px; +} + +blockquote.DocNodeRTL { + border-left: 0; + border-right: 2px solid #9CAFD4; + margin: 0 4px 0 24px; + padding: 0 16px 0 12px; +} + +/* @end */ + +/* +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +*/ + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #A3B4D7; +} + +th.dirtab { + background: #EBEFF6; + font-weight: bold; +} + +hr { + height: 0px; + border: none; + border-top: 1px solid #4A6AAA; +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ + +table.memberdecls { + border-spacing: 0px; + padding: 0px; +} + +.memberdecls td, .fieldtable tr { + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +.memberdecls td.glow, .fieldtable tr.glow { + background-color: cyan; + box-shadow: 0 0 15px cyan; +} + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #F9FAFC; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memSeparator { + border-bottom: 1px solid #DEE4F0; + line-height: 1px; + margin: 0px; + padding: 0px; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memItemRight, .memTemplItemRight { + width: 100%; +} + +.memTemplParams { + color: #4665A2; + white-space: nowrap; + font-size: 80%; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtitle { + padding: 8px; + border-top: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + border-top-right-radius: 4px; + border-top-left-radius: 4px; + margin-bottom: -1px; + background-image: url('nav_f.png'); + background-repeat: repeat-x; + background-color: #E2E8F2; + line-height: 1.25; + font-weight: 300; + float:left; +} + +.permalink +{ + font-size: 65%; + display: inline-block; + vertical-align: middle; +} + +.memtemplate { + font-size: 80%; + color: #4665A2; + font-weight: normal; + margin-left: 9px; +} + +.memnav { + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.mempage { + width: 100%; +} + +.memitem { + padding: 0; + margin-bottom: 10px; + margin-right: 5px; + -webkit-transition: box-shadow 0.5s linear; + -moz-transition: box-shadow 0.5s linear; + -ms-transition: box-shadow 0.5s linear; + -o-transition: box-shadow 0.5s linear; + transition: box-shadow 0.5s linear; + display: table !important; + width: 100%; +} + +.memitem.glow { + box-shadow: 0 0 15px cyan; +} + +.memname { + font-weight: 400; + margin-left: 6px; +} + +.memname td { + vertical-align: bottom; +} + +.memproto, dl.reflist dt { + border-top: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 0px 6px 0px; + color: #253555; + font-weight: bold; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + background-color: #DFE5F1; + /* opera specific markup */ + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + border-top-right-radius: 4px; + /* firefox specific markup */ + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 4px; + /* webkit specific markup */ + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 4px; + +} + +.overload { + font-family: "courier new",courier,monospace; + font-size: 65%; +} + +.memdoc, dl.reflist dd { + border-bottom: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 10px 2px 10px; + background-color: #FBFCFD; + border-top-width: 0; + background-image:url('nav_g.png'); + background-repeat:repeat-x; + background-color: #FFFFFF; + /* opera specific markup */ + border-bottom-left-radius: 4px; + border-bottom-right-radius: 4px; + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + /* firefox specific markup */ + -moz-border-radius-bottomleft: 4px; + -moz-border-radius-bottomright: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +dl.reflist dt { + padding: 5px; +} + +dl.reflist dd { + margin: 0px 0px 10px 0px; + padding: 5px; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} +.paramname code { + line-height: 14px; +} + +.params, .retval, .exception, .tparams { + margin-left: 0px; + padding-left: 0px; +} + +.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname { + font-weight: bold; + vertical-align: top; +} + +.params .paramtype, .tparams .paramtype { + font-style: italic; + vertical-align: top; +} + +.params .paramdir, .tparams .paramdir { + font-family: "courier new",courier,monospace; + vertical-align: top; +} + +table.mlabels { + border-spacing: 0px; +} + +td.mlabels-left { + width: 100%; + padding: 0px; +} + +td.mlabels-right { + vertical-align: bottom; + padding: 0px; + white-space: nowrap; +} + +span.mlabels { + margin-left: 8px; +} + +span.mlabel { + background-color: #728DC1; + border-top:1px solid #5373B4; + border-left:1px solid #5373B4; + border-right:1px solid #C4CFE5; + border-bottom:1px solid #C4CFE5; + text-shadow: none; + color: white; + margin-right: 4px; + padding: 2px 3px; + border-radius: 3px; + font-size: 7pt; + white-space: nowrap; + vertical-align: middle; +} + + + +/* @end */ + +/* these are for tree view inside a (index) page */ + +div.directory { + margin: 10px 0px; + border-top: 1px solid #9CAFD4; + border-bottom: 1px solid #9CAFD4; + width: 100%; +} + +.directory table { + border-collapse:collapse; +} + +.directory td { + margin: 0px; + padding: 0px; + vertical-align: top; +} + +.directory td.entry { + white-space: nowrap; + padding-right: 6px; + padding-top: 3px; +} + +.directory td.entry a { + outline:none; +} + +.directory td.entry a img { + border: none; +} + +.directory td.desc { + width: 100%; + padding-left: 6px; + padding-right: 6px; + padding-top: 3px; + border-left: 1px solid rgba(0,0,0,0.05); +} + +.directory tr.even { + padding-left: 6px; + background-color: #F7F8FB; +} + +.directory img { + vertical-align: -30%; +} + +.directory .levels { + white-space: nowrap; + width: 100%; + text-align: right; + font-size: 9pt; +} + +.directory .levels span { + cursor: pointer; + padding-left: 2px; + padding-right: 2px; + color: #3D578C; +} + +.arrow { + color: #9CAFD4; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + font-size: 80%; + display: inline-block; + width: 16px; + height: 22px; +} + +.icon { + font-family: Arial, Helvetica; + font-weight: bold; + font-size: 12px; + height: 14px; + width: 16px; + display: inline-block; + background-color: #728DC1; + color: white; + text-align: center; + border-radius: 4px; + margin-left: 2px; + margin-right: 2px; +} + +.icona { + width: 24px; + height: 22px; + display: inline-block; +} + +.iconfopen { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('folderopen.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.iconfclosed { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('folderclosed.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.icondoc { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('doc.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +table.directory { + font: 400 14px Roboto,sans-serif; +} + +/* @end */ + +div.dynheader { + margin-top: 8px; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +address { + font-style: normal; + color: #2A3D61; +} + +table.doxtable caption { + caption-side: top; +} + +table.doxtable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +table.fieldtable { + /*width: 100%;*/ + margin-bottom: 10px; + border: 1px solid #A8B8D9; + border-spacing: 0px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + border-radius: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); + box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); +} + +.fieldtable td, .fieldtable th { + padding: 3px 7px 2px; +} + +.fieldtable td.fieldtype, .fieldtable td.fieldname { + white-space: nowrap; + border-right: 1px solid #A8B8D9; + border-bottom: 1px solid #A8B8D9; + vertical-align: top; +} + +.fieldtable td.fieldname { + padding-top: 3px; +} + +.fieldtable td.fielddoc { + border-bottom: 1px solid #A8B8D9; + /*width: 100%;*/ +} + +.fieldtable td.fielddoc p:first-child { + margin-top: 0px; +} + +.fieldtable td.fielddoc p:last-child { + margin-bottom: 2px; +} + +.fieldtable tr:last-child td { + border-bottom: none; +} + +.fieldtable th { + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + font-size: 90%; + color: #253555; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; + font-weight: 400; + -moz-border-radius-topleft: 4px; + -moz-border-radius-topright: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + border-top-left-radius: 4px; + border-top-right-radius: 4px; + border-bottom: 1px solid #A8B8D9; +} + + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + background-image:url('tab_b.png'); + background-repeat:repeat-x; + background-position: 0 -5px; + height:30px; + line-height:30px; + color:#8AA0CC; + border:solid 1px #C2CDE4; + overflow:hidden; + margin:0px; + padding:0px; +} + +.navpath li +{ + list-style-type:none; + float:left; + padding-left:10px; + padding-right:15px; + background-image:url('bc_s.png'); + background-repeat:no-repeat; + background-position:right; + color:#364D7C; +} + +.navpath li.navelem a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; + color: #283A5D; + font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + text-decoration: none; +} + +.navpath li.navelem a:hover +{ + color:#6884BD; +} + +.navpath li.footer +{ + list-style-type:none; + float:right; + padding-left:10px; + padding-right:15px; + background-image:none; + background-repeat:no-repeat; + background-position:right; + color:#364D7C; + font-size: 8pt; +} + + +div.summary +{ + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a +{ + white-space: nowrap; +} + +table.classindex +{ + margin: 10px; + white-space: nowrap; + margin-left: 3%; + margin-right: 3%; + width: 94%; + border: 0; + border-spacing: 0; + padding: 0; +} + +div.ingroups +{ + font-size: 8pt; + width: 50%; + text-align: left; +} + +div.ingroups a +{ + white-space: nowrap; +} + +div.header +{ + background-image:url('nav_h.png'); + background-repeat:repeat-x; + background-color: #F9FAFC; + margin: 0px; + border-bottom: 1px solid #C4CFE5; +} + +div.headertitle +{ + padding: 5px 5px 5px 10px; +} + +.PageDocRTL-title div.headertitle { + text-align: right; + direction: rtl; +} + +dl { + padding: 0 0 0 0; +} + +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug, dl.examples */ +dl.section { + margin-left: 0px; + padding-left: 0px; +} + +dl.section.DocNodeRTL { + margin-right: 0px; + padding-right: 0px; +} + +dl.note { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #D0C000; +} + +dl.note.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #D0C000; +} + +dl.warning, dl.attention { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #FF0000; +} + +dl.warning.DocNodeRTL, dl.attention.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #FF0000; +} + +dl.pre, dl.post, dl.invariant { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #00D000; +} + +dl.pre.DocNodeRTL, dl.post.DocNodeRTL, dl.invariant.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #00D000; +} + +dl.deprecated { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #505050; +} + +dl.deprecated.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #505050; +} + +dl.todo { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #00C0E0; +} + +dl.todo.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #00C0E0; +} + +dl.test { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #3030E0; +} + +dl.test.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #3030E0; +} + +dl.bug { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #C08050; +} + +dl.bug.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #C08050; +} + +dl.section dd { + margin-bottom: 6px; +} + + +#projectrow +{ + height: 56px; +} + +#projectlogo +{ + text-align: center; + vertical-align: bottom; + border-collapse: separate; +} + +#projectlogo img +{ + border: 0px none; +} + +#projectalign +{ + vertical-align: middle; + padding-left: 0.5em; +} + +#projectname +{ + font: 200% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 2px 0px; +} + +#projectbrief +{ + font: 90% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#projectnumber +{ + font: 50% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#titlearea +{ + padding: 0px; + margin: 0px; + width: 100%; + border-bottom: 1px solid #5373B4; +} + +.image +{ + text-align: center; +} + +.dotgraph +{ + text-align: center; +} + +.mscgraph +{ + text-align: center; +} + +.plantumlgraph +{ + text-align: center; +} + +.diagraph +{ + text-align: center; +} + +.caption +{ + font-weight: bold; +} + +div.zoom +{ + border: 1px solid #90A5CE; +} + +dl.citelist { + margin-bottom:50px; +} + +dl.citelist dt { + color:#334975; + float:left; + font-weight:bold; + margin-right:10px; + padding:5px; + text-align:right; + width:52px; +} + +dl.citelist dd { + margin:2px 0 2px 72px; + padding:5px 0; +} + +div.toc { + padding: 14px 25px; + background-color: #F4F6FA; + border: 1px solid #D8DFEE; + border-radius: 7px 7px 7px 7px; + float: right; + height: auto; + margin: 0 8px 10px 10px; + width: 200px; +} + +.PageDocRTL-title div.toc { + float: left !important; + text-align: right; +} + +div.toc li { + background: url("bdwn.png") no-repeat scroll 0 5px transparent; + font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; + margin-top: 5px; + padding-left: 10px; + padding-top: 2px; +} + +.PageDocRTL-title div.toc li { + background-position-x: right !important; + padding-left: 0 !important; + padding-right: 10px; +} + +div.toc h3 { + font: bold 12px/1.2 Arial,FreeSans,sans-serif; + color: #4665A2; + border-bottom: 0 none; + margin: 0; +} + +div.toc ul { + list-style: none outside none; + border: medium none; + padding: 0px; +} + +div.toc li.level1 { + margin-left: 0px; +} + +div.toc li.level2 { + margin-left: 15px; +} + +div.toc li.level3 { + margin-left: 30px; +} + +div.toc li.level4 { + margin-left: 45px; +} + +span.emoji { + /* font family used at the site: https://unicode.org/emoji/charts/full-emoji-list.html + * font-family: "Noto Color Emoji", "Apple Color Emoji", "Segoe UI Emoji", Times, Symbola, Aegyptus, Code2000, Code2001, Code2002, Musica, serif, LastResort; + */ +} + +span.obfuscator { + display: none; +} + +.PageDocRTL-title div.toc li.level1 { + margin-left: 0 !important; + margin-right: 0; +} + +.PageDocRTL-title div.toc li.level2 { + margin-left: 0 !important; + margin-right: 15px; +} + +.PageDocRTL-title div.toc li.level3 { + margin-left: 0 !important; + margin-right: 30px; +} + +.PageDocRTL-title div.toc li.level4 { + margin-left: 0 !important; + margin-right: 45px; +} + +.inherit_header { + font-weight: bold; + color: gray; + cursor: pointer; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.inherit_header td { + padding: 6px 0px 2px 5px; +} + +.inherit { + display: none; +} + +tr.heading h2 { + margin-top: 12px; + margin-bottom: 4px; +} + +/* tooltip related style info */ + +.ttc { + position: absolute; + display: none; +} + +#powerTip { + cursor: default; + /*white-space: nowrap;*/ + background-color: white; + border: 1px solid gray; + border-radius: 4px 4px 4px 4px; + box-shadow: 1px 1px 7px gray; + display: none; + font-size: smaller; + max-width: 80%; + opacity: 0.9; + padding: 1ex 1em 1em; + position: absolute; + z-index: 2147483647; +} + +#powerTip div.ttdoc { + color: grey; + font-style: italic; +} + +#powerTip div.ttname a { + font-weight: bold; +} + +#powerTip div.ttname { + font-weight: bold; +} + +#powerTip div.ttdeci { + color: #006318; +} + +#powerTip div { + margin: 0px; + padding: 0px; + font: 12px/16px Roboto,sans-serif; +} + +#powerTip:before, #powerTip:after { + content: ""; + position: absolute; + margin: 0px; +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.s:after, #powerTip.s:before, +#powerTip.w:after, #powerTip.w:before, +#powerTip.e:after, #powerTip.e:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.nw:after, #powerTip.nw:before, +#powerTip.sw:after, #powerTip.sw:before { + border: solid transparent; + content: " "; + height: 0; + width: 0; + position: absolute; +} + +#powerTip.n:after, #powerTip.s:after, +#powerTip.w:after, #powerTip.e:after, +#powerTip.nw:after, #powerTip.ne:after, +#powerTip.sw:after, #powerTip.se:after { + border-color: rgba(255, 255, 255, 0); +} + +#powerTip.n:before, #powerTip.s:before, +#powerTip.w:before, #powerTip.e:before, +#powerTip.nw:before, #powerTip.ne:before, +#powerTip.sw:before, #powerTip.se:before { + border-color: rgba(128, 128, 128, 0); +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.nw:after, #powerTip.nw:before { + top: 100%; +} + +#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after { + border-top-color: #FFFFFF; + border-width: 10px; + margin: 0px -10px; +} +#powerTip.n:before { + border-top-color: #808080; + border-width: 11px; + margin: 0px -11px; +} +#powerTip.n:after, #powerTip.n:before { + left: 50%; +} + +#powerTip.nw:after, #powerTip.nw:before { + right: 14px; +} + +#powerTip.ne:after, #powerTip.ne:before { + left: 14px; +} + +#powerTip.s:after, #powerTip.s:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.sw:after, #powerTip.sw:before { + bottom: 100%; +} + +#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after { + border-bottom-color: #FFFFFF; + border-width: 10px; + margin: 0px -10px; +} + +#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before { + border-bottom-color: #808080; + border-width: 11px; + margin: 0px -11px; +} + +#powerTip.s:after, #powerTip.s:before { + left: 50%; +} + +#powerTip.sw:after, #powerTip.sw:before { + right: 14px; +} + +#powerTip.se:after, #powerTip.se:before { + left: 14px; +} + +#powerTip.e:after, #powerTip.e:before { + left: 100%; +} +#powerTip.e:after { + border-left-color: #FFFFFF; + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.e:before { + border-left-color: #808080; + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +#powerTip.w:after, #powerTip.w:before { + right: 100%; +} +#powerTip.w:after { + border-right-color: #FFFFFF; + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.w:before { + border-right-color: #808080; + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +@media print +{ + #top { display: none; } + #side-nav { display: none; } + #nav-path { display: none; } + body { overflow:visible; } + h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } + .summary { display: none; } + .memitem { page-break-inside: avoid; } + #doc-content + { + margin-left:0 !important; + height:auto !important; + width:auto !important; + overflow:inherit; + display:inline; + } +} + +/* @group Markdown */ + +table.markdownTable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.markdownTable td, table.markdownTable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.markdownTable tr { +} + +th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +th.markdownTableHeadLeft, td.markdownTableBodyLeft { + text-align: left +} + +th.markdownTableHeadRight, td.markdownTableBodyRight { + text-align: right +} + +th.markdownTableHeadCenter, td.markdownTableBodyCenter { + text-align: center +} + +.DocNodeRTL { + text-align: right; + direction: rtl; +} + +.DocNodeLTR { + text-align: left; + direction: ltr; +} + +table.DocNodeRTL { + width: auto; + margin-right: 0; + margin-left: auto; +} + +table.DocNodeLTR { + width: auto; + margin-right: auto; + margin-left: 0; +} + +code.JavaDocCode + direction:ltr; +} + +tt, code, kbd, samp +{ + display: inline-block; + direction:ltr; +} +/* @end */ + +u { + text-decoration: underline; +} + diff --git a/docs/html/doxygen.svg b/docs/html/doxygen.svg new file mode 100644 index 0000000..d42dad5 --- /dev/null +++ b/docs/html/doxygen.svg @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/dynsections.js b/docs/html/dynsections.js new file mode 100644 index 0000000..3174bd7 --- /dev/null +++ b/docs/html/dynsections.js @@ -0,0 +1,121 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file + */ +function toggleVisibility(linkObj) +{ + var base = $(linkObj).attr('id'); + var summary = $('#'+base+'-summary'); + var content = $('#'+base+'-content'); + var trigger = $('#'+base+'-trigger'); + var src=$(trigger).attr('src'); + if (content.is(':visible')===true) { + content.hide(); + summary.show(); + $(linkObj).addClass('closed').removeClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png'); + } else { + content.show(); + summary.hide(); + $(linkObj).removeClass('closed').addClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-10)+'open.png'); + } + return false; +} + +function updateStripes() +{ + $('table.directory tr'). + removeClass('even').filter(':visible:even').addClass('even'); +} + +function toggleLevel(level) +{ + $('table.directory tr').each(function() { + var l = this.id.split('_').length-1; + var i = $('#img'+this.id.substring(3)); + var a = $('#arr'+this.id.substring(3)); + if (l + + + + + + +Vulk: File List + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + +
+
+
File List
+
+
+
Here is a list of all files with brief descriptions:
+
[detail level 12345]
+ + + + + + + + + + + + + + + + + + + + + +
 ▼ lib
 ▼ include
 ▼ Vulk
 ▼ Contexts
 ContextGLFW.hpp
 ContextVulkan.hpp
 ClassUtils.hpp
 Exceptions.hpp
 FrameManager.hpp
 Keyboard.hpp
 Mat3.hpp
 Mouse.hpp
 Objects.hpp
 Rect.hpp
 ScopedProfiler.hpp
 Shader.hpp
 Time.hpp
 Utils.hpp
 Vec2.hpp
 Vec3.hpp
 Window.hpp
+
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/folderclosed.png b/docs/html/folderclosed.png new file mode 100644 index 0000000000000000000000000000000000000000..bb8ab35edce8e97554e360005ee9fc5bffb36e66 GIT binary patch literal 616 zcmV-u0+;=XP)a9#ETzayK)T~Jw&MMH>OIr#&;dC}is*2Mqdf&akCc=O@`qC+4i z5Iu3w#1M@KqXCz8TIZd1wli&kkl2HVcAiZ8PUn5z_kG@-y;?yK06=cA0U%H0PH+kU zl6dp}OR(|r8-RG+YLu`zbI}5TlOU6ToR41{9=uz^?dGTNL;wIMf|V3`d1Wj3y!#6` zBLZ?xpKR~^2x}?~zA(_NUu3IaDB$tKma*XUdOZN~c=dLt_h_k!dbxm_*ibDM zlFX`g{k$X}yIe%$N)cn1LNu=q9_CS)*>A zsX_mM4L@`(cSNQKMFc$RtYbx{79#j-J7hk*>*+ZZhM4Hw?I?rsXCi#mRWJ=-0LGV5a-WR0Qgt<|Nqf)C-@80`5gIz45^_20000IqP)X=#(TiCT&PiIIVc55T}TU}EUh*{q$|`3@{d>{Tc9Bo>e= zfmF3!f>fbI9#GoEHh0f`i5)wkLpva0ztf%HpZneK?w-7AK@b4Itw{y|Zd3k!fH?q2 zlhckHd_V2M_X7+)U&_Xcfvtw60l;--DgZmLSw-Y?S>)zIqMyJ1#FwLU*%bl38ok+! zh78H87n`ZTS;uhzAR$M`zZ`bVhq=+%u9^$5jDplgxd44}9;IRqUH1YHH|@6oFe%z( zo4)_>E$F&^P-f(#)>(TrnbE>Pefs9~@iN=|)Rz|V`sGfHNrJ)0gJb8xx+SBmRf@1l zvuzt=vGfI)<-F9!o&3l?>9~0QbUDT(wFdnQPv%xdD)m*g%!20>Bc9iYmGAp<9YAa( z0QgYgTWqf1qN++Gqp z8@AYPTB3E|6s=WLG?xw0tm|U!o=&zd+H0oRYE;Dbx+Na9s^STqX|Gnq%H8s(nGDGJ j8vwW|`Ts`)fSK|Kx=IK@RG@g200000NkvXXu0mjfauFEA literal 0 HcmV?d00001 diff --git a/docs/html/functions.html b/docs/html/functions.html new file mode 100644 index 0000000..22f548f --- /dev/null +++ b/docs/html/functions.html @@ -0,0 +1,232 @@ + + + + + + + +Vulk: Class Members + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + +
+
+
Here is a list of all class members with links to the classes they belong to:
+ +

- a -

    +
  • AttributeDescriptions : Vertex
    • +
+ + +

- c -

+ + +

- d -

+ + +

- e -

+ + +

- f -

+ + +

- g -

+ + +

- h -

+ + +

- i -

+ + +

- k -

+ + +

- l -

+ + +

- m -

+ + +

- n -

+ + +

- o -

+ + +

- p -

+ + +

- r -

+ + +

- s -

+ + +

- t -

+ + +

- u -

+ + +

- v -

+ + +

- w -

+ + +

- x -

+ + +

- y -

+ + +

- z -

+ + +

- ~ -

+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html new file mode 100644 index 0000000..286e868 --- /dev/null +++ b/docs/html/functions_func.html @@ -0,0 +1,185 @@ + + + + + + + +Vulk: Class Members - Functions + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + +
+
+  + +

- c -

+ + +

- d -

+ + +

- e -

+ + +

- f -

+ + +

- g -

+ + +

- i -

+ + +

- k -

+ + +

- l -

+ + +

- m -

+ + +

- n -

+ + +

- o -

+ + +

- p -

+ + +

- r -

+ + +

- s -

+ + +

- u -

+ + +

- v -

+ + +

- w -

+ + +

- ~ -

+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/functions_rela.html b/docs/html/functions_rela.html new file mode 100644 index 0000000..dfffe5f --- /dev/null +++ b/docs/html/functions_rela.html @@ -0,0 +1,51 @@ + + + + + + + +Vulk: Class Members - Related Functions + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + +
+
+  +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/functions_type.html b/docs/html/functions_type.html new file mode 100644 index 0000000..c25e747 --- /dev/null +++ b/docs/html/functions_type.html @@ -0,0 +1,58 @@ + + + + + + + +Vulk: Class Members - Typedefs + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + +
+
+  +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html new file mode 100644 index 0000000..cd0ead2 --- /dev/null +++ b/docs/html/functions_vars.html @@ -0,0 +1,64 @@ + + + + + + + +Vulk: Class Members - Variables + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + +
+
+  +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/globals.html b/docs/html/globals.html new file mode 100644 index 0000000..6f75bf2 --- /dev/null +++ b/docs/html/globals.html @@ -0,0 +1,61 @@ + + + + + + + +Vulk: File Members + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + +
+
+
Here is a list of all file members with links to the files they belong to:
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/globals_defs.html b/docs/html/globals_defs.html new file mode 100644 index 0000000..cb5cc8b --- /dev/null +++ b/docs/html/globals_defs.html @@ -0,0 +1,60 @@ + + + + + + + +Vulk: File Members + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + +
+
+  +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/globals_func.html b/docs/html/globals_func.html new file mode 100644 index 0000000..220271d --- /dev/null +++ b/docs/html/globals_func.html @@ -0,0 +1,51 @@ + + + + + + + +Vulk: File Members + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + +
+
+  +
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html new file mode 100644 index 0000000..0770d9e --- /dev/null +++ b/docs/html/hierarchy.html @@ -0,0 +1,75 @@ + + + + + + + +Vulk: Class Hierarchy + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + +
+
+
Class Hierarchy
+
+
+
This inheritance list is sorted roughly, but not completely, alphabetically:
+
[detail level 12]
+ + + + + + + + + + + + + + + + + + + + +
 Cvulk::ContextGLFW
 Cvulk::ContextVulkan
 ▼Cstd::exception
 Cvulk::Exception
 Cvulk::FrameManager
 Cvulk::Keyboard
 ▼CLibraryException
 Cvulk::GLFWException
 Cvulk::VulkanException
 Cvulk::Mat3< T >
 Cvulk::Mouse
 Cvulk::Rect< T >
 Cvulk::utils::ScopedProfiler
 Cvulk::Shader
 CTypeChecker< T >
 CUniformBufferObject
 Cvulk::Vec2< T >
 Cvulk::Vec3< T >
 CVertex
 Cvulk::Window
+
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/index.html b/docs/html/index.html new file mode 100644 index 0000000..4c96c65 --- /dev/null +++ b/docs/html/index.html @@ -0,0 +1,51 @@ + + + + + + + +Vulk: Main Page + + + + + + +
+
+ + + + + + +
+
Vulk +
+
+
+ + + + + + +
+
+
Vulk Documentation
+
+
+
+ +
+Generated by doxygen 1.9.3 +
+ + diff --git a/docs/html/jquery.js b/docs/html/jquery.js new file mode 100644 index 0000000..c9ed3d9 --- /dev/null +++ b/docs/html/jquery.js @@ -0,0 +1,35 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0a;a++)for(i in o[a])n=o[a][i],o[a].hasOwnProperty(i)&&void 0!==n&&(e[i]=t.isPlainObject(n)?t.isPlainObject(e[i])?t.widget.extend({},e[i],n):t.widget.extend({},n):n);return e},t.widget.bridge=function(e,i){var n=i.prototype.widgetFullName||e;t.fn[e]=function(o){var a="string"==typeof o,r=s.call(arguments,1),h=this;return a?this.length||"instance"!==o?this.each(function(){var i,s=t.data(this,n);return"instance"===o?(h=s,!1):s?t.isFunction(s[o])&&"_"!==o.charAt(0)?(i=s[o].apply(s,r),i!==s&&void 0!==i?(h=i&&i.jquery?h.pushStack(i.get()):i,!1):void 0):t.error("no such method '"+o+"' for "+e+" widget instance"):t.error("cannot call methods on "+e+" prior to initialization; "+"attempted to call method '"+o+"'")}):h=void 0:(r.length&&(o=t.widget.extend.apply(null,[o].concat(r))),this.each(function(){var e=t.data(this,n);e?(e.option(o||{}),e._init&&e._init()):t.data(this,n,new i(o,this))})),h}},t.Widget=function(){},t.Widget._childConstructors=[],t.Widget.prototype={widgetName:"widget",widgetEventPrefix:"",defaultElement:"
",options:{classes:{},disabled:!1,create:null},_createWidget:function(e,s){s=t(s||this.defaultElement||this)[0],this.element=t(s),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=t(),this.hoverable=t(),this.focusable=t(),this.classesElementLookup={},s!==this&&(t.data(s,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===s&&this.destroy()}}),this.document=t(s.style?s.ownerDocument:s.document||s),this.window=t(this.document[0].defaultView||this.document[0].parentWindow)),this.options=t.widget.extend({},this.options,this._getCreateOptions(),e),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:t.noop,_create:t.noop,_init:t.noop,destroy:function(){var e=this;this._destroy(),t.each(this.classesElementLookup,function(t,i){e._removeClass(i,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:t.noop,widget:function(){return this.element},option:function(e,i){var s,n,o,a=e;if(0===arguments.length)return t.widget.extend({},this.options);if("string"==typeof e)if(a={},s=e.split("."),e=s.shift(),s.length){for(n=a[e]=t.widget.extend({},this.options[e]),o=0;s.length-1>o;o++)n[s[o]]=n[s[o]]||{},n=n[s[o]];if(e=s.pop(),1===arguments.length)return void 0===n[e]?null:n[e];n[e]=i}else{if(1===arguments.length)return void 0===this.options[e]?null:this.options[e];a[e]=i}return this._setOptions(a),this},_setOptions:function(t){var e;for(e in t)this._setOption(e,t[e]);return this},_setOption:function(t,e){return"classes"===t&&this._setOptionClasses(e),this.options[t]=e,"disabled"===t&&this._setOptionDisabled(e),this},_setOptionClasses:function(e){var i,s,n;for(i in e)n=this.classesElementLookup[i],e[i]!==this.options.classes[i]&&n&&n.length&&(s=t(n.get()),this._removeClass(n,i),s.addClass(this._classes({element:s,keys:i,classes:e,add:!0})))},_setOptionDisabled:function(t){this._toggleClass(this.widget(),this.widgetFullName+"-disabled",null,!!t),t&&(this._removeClass(this.hoverable,null,"ui-state-hover"),this._removeClass(this.focusable,null,"ui-state-focus"))},enable:function(){return this._setOptions({disabled:!1})},disable:function(){return this._setOptions({disabled:!0})},_classes:function(e){function i(i,o){var a,r;for(r=0;i.length>r;r++)a=n.classesElementLookup[i[r]]||t(),a=e.add?t(t.unique(a.get().concat(e.element.get()))):t(a.not(e.element).get()),n.classesElementLookup[i[r]]=a,s.push(i[r]),o&&e.classes[i[r]]&&s.push(e.classes[i[r]])}var s=[],n=this;return e=t.extend({element:this.element,classes:this.options.classes||{}},e),this._on(e.element,{remove:"_untrackClassesElement"}),e.keys&&i(e.keys.match(/\S+/g)||[],!0),e.extra&&i(e.extra.match(/\S+/g)||[]),s.join(" ")},_untrackClassesElement:function(e){var i=this;t.each(i.classesElementLookup,function(s,n){-1!==t.inArray(e.target,n)&&(i.classesElementLookup[s]=t(n.not(e.target).get()))})},_removeClass:function(t,e,i){return this._toggleClass(t,e,i,!1)},_addClass:function(t,e,i){return this._toggleClass(t,e,i,!0)},_toggleClass:function(t,e,i,s){s="boolean"==typeof s?s:i;var n="string"==typeof t||null===t,o={extra:n?e:i,keys:n?t:e,element:n?this.element:t,add:s};return o.element.toggleClass(this._classes(o),s),this},_on:function(e,i,s){var n,o=this;"boolean"!=typeof e&&(s=i,i=e,e=!1),s?(i=n=t(i),this.bindings=this.bindings.add(i)):(s=i,i=this.element,n=this.widget()),t.each(s,function(s,a){function r(){return e||o.options.disabled!==!0&&!t(this).hasClass("ui-state-disabled")?("string"==typeof a?o[a]:a).apply(o,arguments):void 0}"string"!=typeof a&&(r.guid=a.guid=a.guid||r.guid||t.guid++);var h=s.match(/^([\w:-]*)\s*(.*)$/),l=h[1]+o.eventNamespace,c=h[2];c?n.on(l,c,r):i.on(l,r)})},_off:function(e,i){i=(i||"").split(" ").join(this.eventNamespace+" ")+this.eventNamespace,e.off(i).off(i),this.bindings=t(this.bindings.not(e).get()),this.focusable=t(this.focusable.not(e).get()),this.hoverable=t(this.hoverable.not(e).get())},_delay:function(t,e){function i(){return("string"==typeof t?s[t]:t).apply(s,arguments)}var s=this;return setTimeout(i,e||0)},_hoverable:function(e){this.hoverable=this.hoverable.add(e),this._on(e,{mouseenter:function(e){this._addClass(t(e.currentTarget),null,"ui-state-hover")},mouseleave:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-hover")}})},_focusable:function(e){this.focusable=this.focusable.add(e),this._on(e,{focusin:function(e){this._addClass(t(e.currentTarget),null,"ui-state-focus")},focusout:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-focus")}})},_trigger:function(e,i,s){var n,o,a=this.options[e];if(s=s||{},i=t.Event(i),i.type=(e===this.widgetEventPrefix?e:this.widgetEventPrefix+e).toLowerCase(),i.target=this.element[0],o=i.originalEvent)for(n in o)n in i||(i[n]=o[n]);return this.element.trigger(i,s),!(t.isFunction(a)&&a.apply(this.element[0],[i].concat(s))===!1||i.isDefaultPrevented())}},t.each({show:"fadeIn",hide:"fadeOut"},function(e,i){t.Widget.prototype["_"+e]=function(s,n,o){"string"==typeof n&&(n={effect:n});var a,r=n?n===!0||"number"==typeof n?i:n.effect||i:e;n=n||{},"number"==typeof n&&(n={duration:n}),a=!t.isEmptyObject(n),n.complete=o,n.delay&&s.delay(n.delay),a&&t.effects&&t.effects.effect[r]?s[e](n):r!==e&&s[r]?s[r](n.duration,n.easing,o):s.queue(function(i){t(this)[e](),o&&o.call(s[0]),i()})}}),t.widget,function(){function e(t,e,i){return[parseFloat(t[0])*(u.test(t[0])?e/100:1),parseFloat(t[1])*(u.test(t[1])?i/100:1)]}function i(e,i){return parseInt(t.css(e,i),10)||0}function s(e){var i=e[0];return 9===i.nodeType?{width:e.width(),height:e.height(),offset:{top:0,left:0}}:t.isWindow(i)?{width:e.width(),height:e.height(),offset:{top:e.scrollTop(),left:e.scrollLeft()}}:i.preventDefault?{width:0,height:0,offset:{top:i.pageY,left:i.pageX}}:{width:e.outerWidth(),height:e.outerHeight(),offset:e.offset()}}var n,o=Math.max,a=Math.abs,r=/left|center|right/,h=/top|center|bottom/,l=/[\+\-]\d+(\.[\d]+)?%?/,c=/^\w+/,u=/%$/,d=t.fn.position;t.position={scrollbarWidth:function(){if(void 0!==n)return n;var e,i,s=t("
"),o=s.children()[0];return t("body").append(s),e=o.offsetWidth,s.css("overflow","scroll"),i=o.offsetWidth,e===i&&(i=s[0].clientWidth),s.remove(),n=e-i},getScrollInfo:function(e){var i=e.isWindow||e.isDocument?"":e.element.css("overflow-x"),s=e.isWindow||e.isDocument?"":e.element.css("overflow-y"),n="scroll"===i||"auto"===i&&e.widthi?"left":e>0?"right":"center",vertical:0>r?"top":s>0?"bottom":"middle"};l>p&&p>a(e+i)&&(u.horizontal="center"),c>f&&f>a(s+r)&&(u.vertical="middle"),u.important=o(a(e),a(i))>o(a(s),a(r))?"horizontal":"vertical",n.using.call(this,t,u)}),h.offset(t.extend(D,{using:r}))})},t.ui.position={fit:{left:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollLeft:s.offset.left,a=s.width,r=t.left-e.collisionPosition.marginLeft,h=n-r,l=r+e.collisionWidth-a-n;e.collisionWidth>a?h>0&&0>=l?(i=t.left+h+e.collisionWidth-a-n,t.left+=h-i):t.left=l>0&&0>=h?n:h>l?n+a-e.collisionWidth:n:h>0?t.left+=h:l>0?t.left-=l:t.left=o(t.left-r,t.left)},top:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollTop:s.offset.top,a=e.within.height,r=t.top-e.collisionPosition.marginTop,h=n-r,l=r+e.collisionHeight-a-n;e.collisionHeight>a?h>0&&0>=l?(i=t.top+h+e.collisionHeight-a-n,t.top+=h-i):t.top=l>0&&0>=h?n:h>l?n+a-e.collisionHeight:n:h>0?t.top+=h:l>0?t.top-=l:t.top=o(t.top-r,t.top)}},flip:{left:function(t,e){var i,s,n=e.within,o=n.offset.left+n.scrollLeft,r=n.width,h=n.isWindow?n.scrollLeft:n.offset.left,l=t.left-e.collisionPosition.marginLeft,c=l-h,u=l+e.collisionWidth-r-h,d="left"===e.my[0]?-e.elemWidth:"right"===e.my[0]?e.elemWidth:0,p="left"===e.at[0]?e.targetWidth:"right"===e.at[0]?-e.targetWidth:0,f=-2*e.offset[0];0>c?(i=t.left+d+p+f+e.collisionWidth-r-o,(0>i||a(c)>i)&&(t.left+=d+p+f)):u>0&&(s=t.left-e.collisionPosition.marginLeft+d+p+f-h,(s>0||u>a(s))&&(t.left+=d+p+f))},top:function(t,e){var i,s,n=e.within,o=n.offset.top+n.scrollTop,r=n.height,h=n.isWindow?n.scrollTop:n.offset.top,l=t.top-e.collisionPosition.marginTop,c=l-h,u=l+e.collisionHeight-r-h,d="top"===e.my[1],p=d?-e.elemHeight:"bottom"===e.my[1]?e.elemHeight:0,f="top"===e.at[1]?e.targetHeight:"bottom"===e.at[1]?-e.targetHeight:0,m=-2*e.offset[1];0>c?(s=t.top+p+f+m+e.collisionHeight-r-o,(0>s||a(c)>s)&&(t.top+=p+f+m)):u>0&&(i=t.top-e.collisionPosition.marginTop+p+f+m-h,(i>0||u>a(i))&&(t.top+=p+f+m))}},flipfit:{left:function(){t.ui.position.flip.left.apply(this,arguments),t.ui.position.fit.left.apply(this,arguments)},top:function(){t.ui.position.flip.top.apply(this,arguments),t.ui.position.fit.top.apply(this,arguments)}}}}(),t.ui.position,t.extend(t.expr[":"],{data:t.expr.createPseudo?t.expr.createPseudo(function(e){return function(i){return!!t.data(i,e)}}):function(e,i,s){return!!t.data(e,s[3])}}),t.fn.extend({disableSelection:function(){var t="onselectstart"in document.createElement("div")?"selectstart":"mousedown";return function(){return this.on(t+".ui-disableSelection",function(t){t.preventDefault()})}}(),enableSelection:function(){return this.off(".ui-disableSelection")}}),t.ui.focusable=function(i,s){var n,o,a,r,h,l=i.nodeName.toLowerCase();return"area"===l?(n=i.parentNode,o=n.name,i.href&&o&&"map"===n.nodeName.toLowerCase()?(a=t("img[usemap='#"+o+"']"),a.length>0&&a.is(":visible")):!1):(/^(input|select|textarea|button|object)$/.test(l)?(r=!i.disabled,r&&(h=t(i).closest("fieldset")[0],h&&(r=!h.disabled))):r="a"===l?i.href||s:s,r&&t(i).is(":visible")&&e(t(i)))},t.extend(t.expr[":"],{focusable:function(e){return t.ui.focusable(e,null!=t.attr(e,"tabindex"))}}),t.ui.focusable,t.fn.form=function(){return"string"==typeof this[0].form?this.closest("form"):t(this[0].form)},t.ui.formResetMixin={_formResetHandler:function(){var e=t(this);setTimeout(function(){var i=e.data("ui-form-reset-instances");t.each(i,function(){this.refresh()})})},_bindFormResetHandler:function(){if(this.form=this.element.form(),this.form.length){var t=this.form.data("ui-form-reset-instances")||[];t.length||this.form.on("reset.ui-form-reset",this._formResetHandler),t.push(this),this.form.data("ui-form-reset-instances",t)}},_unbindFormResetHandler:function(){if(this.form.length){var e=this.form.data("ui-form-reset-instances");e.splice(t.inArray(this,e),1),e.length?this.form.data("ui-form-reset-instances",e):this.form.removeData("ui-form-reset-instances").off("reset.ui-form-reset")}}},"1.7"===t.fn.jquery.substring(0,3)&&(t.each(["Width","Height"],function(e,i){function s(e,i,s,o){return t.each(n,function(){i-=parseFloat(t.css(e,"padding"+this))||0,s&&(i-=parseFloat(t.css(e,"border"+this+"Width"))||0),o&&(i-=parseFloat(t.css(e,"margin"+this))||0)}),i}var n="Width"===i?["Left","Right"]:["Top","Bottom"],o=i.toLowerCase(),a={innerWidth:t.fn.innerWidth,innerHeight:t.fn.innerHeight,outerWidth:t.fn.outerWidth,outerHeight:t.fn.outerHeight};t.fn["inner"+i]=function(e){return void 0===e?a["inner"+i].call(this):this.each(function(){t(this).css(o,s(this,e)+"px")})},t.fn["outer"+i]=function(e,n){return"number"!=typeof e?a["outer"+i].call(this,e):this.each(function(){t(this).css(o,s(this,e,!0,n)+"px")})}}),t.fn.addBack=function(t){return this.add(null==t?this.prevObject:this.prevObject.filter(t))}),t.ui.keyCode={BACKSPACE:8,COMMA:188,DELETE:46,DOWN:40,END:35,ENTER:13,ESCAPE:27,HOME:36,LEFT:37,PAGE_DOWN:34,PAGE_UP:33,PERIOD:190,RIGHT:39,SPACE:32,TAB:9,UP:38},t.ui.escapeSelector=function(){var t=/([!"#$%&'()*+,./:;<=>?@[\]^`{|}~])/g;return function(e){return e.replace(t,"\\$1")}}(),t.fn.labels=function(){var e,i,s,n,o;return this[0].labels&&this[0].labels.length?this.pushStack(this[0].labels):(n=this.eq(0).parents("label"),s=this.attr("id"),s&&(e=this.eq(0).parents().last(),o=e.add(e.length?e.siblings():this.siblings()),i="label[for='"+t.ui.escapeSelector(s)+"']",n=n.add(o.find(i).addBack(i))),this.pushStack(n))},t.fn.scrollParent=function(e){var i=this.css("position"),s="absolute"===i,n=e?/(auto|scroll|hidden)/:/(auto|scroll)/,o=this.parents().filter(function(){var e=t(this);return s&&"static"===e.css("position")?!1:n.test(e.css("overflow")+e.css("overflow-y")+e.css("overflow-x"))}).eq(0);return"fixed"!==i&&o.length?o:t(this[0].ownerDocument||document)},t.extend(t.expr[":"],{tabbable:function(e){var i=t.attr(e,"tabindex"),s=null!=i;return(!s||i>=0)&&t.ui.focusable(e,s)}}),t.fn.extend({uniqueId:function(){var t=0;return function(){return this.each(function(){this.id||(this.id="ui-id-"+ ++t)})}}(),removeUniqueId:function(){return this.each(function(){/^ui-id-\d+$/.test(this.id)&&t(this).removeAttr("id")})}}),t.ui.ie=!!/msie [\w.]+/.exec(navigator.userAgent.toLowerCase());var n=!1;t(document).on("mouseup",function(){n=!1}),t.widget("ui.mouse",{version:"1.12.1",options:{cancel:"input, textarea, button, select, option",distance:1,delay:0},_mouseInit:function(){var e=this;this.element.on("mousedown."+this.widgetName,function(t){return e._mouseDown(t)}).on("click."+this.widgetName,function(i){return!0===t.data(i.target,e.widgetName+".preventClickEvent")?(t.removeData(i.target,e.widgetName+".preventClickEvent"),i.stopImmediatePropagation(),!1):void 0}),this.started=!1},_mouseDestroy:function(){this.element.off("."+this.widgetName),this._mouseMoveDelegate&&this.document.off("mousemove."+this.widgetName,this._mouseMoveDelegate).off("mouseup."+this.widgetName,this._mouseUpDelegate)},_mouseDown:function(e){if(!n){this._mouseMoved=!1,this._mouseStarted&&this._mouseUp(e),this._mouseDownEvent=e;var i=this,s=1===e.which,o="string"==typeof this.options.cancel&&e.target.nodeName?t(e.target).closest(this.options.cancel).length:!1;return s&&!o&&this._mouseCapture(e)?(this.mouseDelayMet=!this.options.delay,this.mouseDelayMet||(this._mouseDelayTimer=setTimeout(function(){i.mouseDelayMet=!0},this.options.delay)),this._mouseDistanceMet(e)&&this._mouseDelayMet(e)&&(this._mouseStarted=this._mouseStart(e)!==!1,!this._mouseStarted)?(e.preventDefault(),!0):(!0===t.data(e.target,this.widgetName+".preventClickEvent")&&t.removeData(e.target,this.widgetName+".preventClickEvent"),this._mouseMoveDelegate=function(t){return i._mouseMove(t)},this._mouseUpDelegate=function(t){return i._mouseUp(t)},this.document.on("mousemove."+this.widgetName,this._mouseMoveDelegate).on("mouseup."+this.widgetName,this._mouseUpDelegate),e.preventDefault(),n=!0,!0)):!0}},_mouseMove:function(e){if(this._mouseMoved){if(t.ui.ie&&(!document.documentMode||9>document.documentMode)&&!e.button)return this._mouseUp(e);if(!e.which)if(e.originalEvent.altKey||e.originalEvent.ctrlKey||e.originalEvent.metaKey||e.originalEvent.shiftKey)this.ignoreMissingWhich=!0;else if(!this.ignoreMissingWhich)return this._mouseUp(e)}return(e.which||e.button)&&(this._mouseMoved=!0),this._mouseStarted?(this._mouseDrag(e),e.preventDefault()):(this._mouseDistanceMet(e)&&this._mouseDelayMet(e)&&(this._mouseStarted=this._mouseStart(this._mouseDownEvent,e)!==!1,this._mouseStarted?this._mouseDrag(e):this._mouseUp(e)),!this._mouseStarted)},_mouseUp:function(e){this.document.off("mousemove."+this.widgetName,this._mouseMoveDelegate).off("mouseup."+this.widgetName,this._mouseUpDelegate),this._mouseStarted&&(this._mouseStarted=!1,e.target===this._mouseDownEvent.target&&t.data(e.target,this.widgetName+".preventClickEvent",!0),this._mouseStop(e)),this._mouseDelayTimer&&(clearTimeout(this._mouseDelayTimer),delete this._mouseDelayTimer),this.ignoreMissingWhich=!1,n=!1,e.preventDefault()},_mouseDistanceMet:function(t){return Math.max(Math.abs(this._mouseDownEvent.pageX-t.pageX),Math.abs(this._mouseDownEvent.pageY-t.pageY))>=this.options.distance},_mouseDelayMet:function(){return this.mouseDelayMet},_mouseStart:function(){},_mouseDrag:function(){},_mouseStop:function(){},_mouseCapture:function(){return!0}}),t.ui.plugin={add:function(e,i,s){var n,o=t.ui[e].prototype;for(n in s)o.plugins[n]=o.plugins[n]||[],o.plugins[n].push([i,s[n]])},call:function(t,e,i,s){var n,o=t.plugins[e];if(o&&(s||t.element[0].parentNode&&11!==t.element[0].parentNode.nodeType))for(n=0;o.length>n;n++)t.options[o[n][0]]&&o[n][1].apply(t.element,i)}},t.widget("ui.resizable",t.ui.mouse,{version:"1.12.1",widgetEventPrefix:"resize",options:{alsoResize:!1,animate:!1,animateDuration:"slow",animateEasing:"swing",aspectRatio:!1,autoHide:!1,classes:{"ui-resizable-se":"ui-icon ui-icon-gripsmall-diagonal-se"},containment:!1,ghost:!1,grid:!1,handles:"e,s,se",helper:!1,maxHeight:null,maxWidth:null,minHeight:10,minWidth:10,zIndex:90,resize:null,start:null,stop:null},_num:function(t){return parseFloat(t)||0},_isNumber:function(t){return!isNaN(parseFloat(t))},_hasScroll:function(e,i){if("hidden"===t(e).css("overflow"))return!1;var s=i&&"left"===i?"scrollLeft":"scrollTop",n=!1;return e[s]>0?!0:(e[s]=1,n=e[s]>0,e[s]=0,n)},_create:function(){var e,i=this.options,s=this;this._addClass("ui-resizable"),t.extend(this,{_aspectRatio:!!i.aspectRatio,aspectRatio:i.aspectRatio,originalElement:this.element,_proportionallyResizeElements:[],_helper:i.helper||i.ghost||i.animate?i.helper||"ui-resizable-helper":null}),this.element[0].nodeName.match(/^(canvas|textarea|input|select|button|img)$/i)&&(this.element.wrap(t("
").css({position:this.element.css("position"),width:this.element.outerWidth(),height:this.element.outerHeight(),top:this.element.css("top"),left:this.element.css("left")})),this.element=this.element.parent().data("ui-resizable",this.element.resizable("instance")),this.elementIsWrapper=!0,e={marginTop:this.originalElement.css("marginTop"),marginRight:this.originalElement.css("marginRight"),marginBottom:this.originalElement.css("marginBottom"),marginLeft:this.originalElement.css("marginLeft")},this.element.css(e),this.originalElement.css("margin",0),this.originalResizeStyle=this.originalElement.css("resize"),this.originalElement.css("resize","none"),this._proportionallyResizeElements.push(this.originalElement.css({position:"static",zoom:1,display:"block"})),this.originalElement.css(e),this._proportionallyResize()),this._setupHandles(),i.autoHide&&t(this.element).on("mouseenter",function(){i.disabled||(s._removeClass("ui-resizable-autohide"),s._handles.show())}).on("mouseleave",function(){i.disabled||s.resizing||(s._addClass("ui-resizable-autohide"),s._handles.hide())}),this._mouseInit()},_destroy:function(){this._mouseDestroy();var e,i=function(e){t(e).removeData("resizable").removeData("ui-resizable").off(".resizable").find(".ui-resizable-handle").remove()};return this.elementIsWrapper&&(i(this.element),e=this.element,this.originalElement.css({position:e.css("position"),width:e.outerWidth(),height:e.outerHeight(),top:e.css("top"),left:e.css("left")}).insertAfter(e),e.remove()),this.originalElement.css("resize",this.originalResizeStyle),i(this.originalElement),this},_setOption:function(t,e){switch(this._super(t,e),t){case"handles":this._removeHandles(),this._setupHandles();break;default:}},_setupHandles:function(){var e,i,s,n,o,a=this.options,r=this;if(this.handles=a.handles||(t(".ui-resizable-handle",this.element).length?{n:".ui-resizable-n",e:".ui-resizable-e",s:".ui-resizable-s",w:".ui-resizable-w",se:".ui-resizable-se",sw:".ui-resizable-sw",ne:".ui-resizable-ne",nw:".ui-resizable-nw"}:"e,s,se"),this._handles=t(),this.handles.constructor===String)for("all"===this.handles&&(this.handles="n,e,s,w,se,sw,ne,nw"),s=this.handles.split(","),this.handles={},i=0;s.length>i;i++)e=t.trim(s[i]),n="ui-resizable-"+e,o=t("
"),this._addClass(o,"ui-resizable-handle "+n),o.css({zIndex:a.zIndex}),this.handles[e]=".ui-resizable-"+e,this.element.append(o);this._renderAxis=function(e){var i,s,n,o;e=e||this.element;for(i in this.handles)this.handles[i].constructor===String?this.handles[i]=this.element.children(this.handles[i]).first().show():(this.handles[i].jquery||this.handles[i].nodeType)&&(this.handles[i]=t(this.handles[i]),this._on(this.handles[i],{mousedown:r._mouseDown})),this.elementIsWrapper&&this.originalElement[0].nodeName.match(/^(textarea|input|select|button)$/i)&&(s=t(this.handles[i],this.element),o=/sw|ne|nw|se|n|s/.test(i)?s.outerHeight():s.outerWidth(),n=["padding",/ne|nw|n/.test(i)?"Top":/se|sw|s/.test(i)?"Bottom":/^e$/.test(i)?"Right":"Left"].join(""),e.css(n,o),this._proportionallyResize()),this._handles=this._handles.add(this.handles[i])},this._renderAxis(this.element),this._handles=this._handles.add(this.element.find(".ui-resizable-handle")),this._handles.disableSelection(),this._handles.on("mouseover",function(){r.resizing||(this.className&&(o=this.className.match(/ui-resizable-(se|sw|ne|nw|n|e|s|w)/i)),r.axis=o&&o[1]?o[1]:"se")}),a.autoHide&&(this._handles.hide(),this._addClass("ui-resizable-autohide"))},_removeHandles:function(){this._handles.remove()},_mouseCapture:function(e){var i,s,n=!1;for(i in this.handles)s=t(this.handles[i])[0],(s===e.target||t.contains(s,e.target))&&(n=!0);return!this.options.disabled&&n},_mouseStart:function(e){var i,s,n,o=this.options,a=this.element;return this.resizing=!0,this._renderProxy(),i=this._num(this.helper.css("left")),s=this._num(this.helper.css("top")),o.containment&&(i+=t(o.containment).scrollLeft()||0,s+=t(o.containment).scrollTop()||0),this.offset=this.helper.offset(),this.position={left:i,top:s},this.size=this._helper?{width:this.helper.width(),height:this.helper.height()}:{width:a.width(),height:a.height()},this.originalSize=this._helper?{width:a.outerWidth(),height:a.outerHeight()}:{width:a.width(),height:a.height()},this.sizeDiff={width:a.outerWidth()-a.width(),height:a.outerHeight()-a.height()},this.originalPosition={left:i,top:s},this.originalMousePosition={left:e.pageX,top:e.pageY},this.aspectRatio="number"==typeof o.aspectRatio?o.aspectRatio:this.originalSize.width/this.originalSize.height||1,n=t(".ui-resizable-"+this.axis).css("cursor"),t("body").css("cursor","auto"===n?this.axis+"-resize":n),this._addClass("ui-resizable-resizing"),this._propagate("start",e),!0},_mouseDrag:function(e){var i,s,n=this.originalMousePosition,o=this.axis,a=e.pageX-n.left||0,r=e.pageY-n.top||0,h=this._change[o];return this._updatePrevProperties(),h?(i=h.apply(this,[e,a,r]),this._updateVirtualBoundaries(e.shiftKey),(this._aspectRatio||e.shiftKey)&&(i=this._updateRatio(i,e)),i=this._respectSize(i,e),this._updateCache(i),this._propagate("resize",e),s=this._applyChanges(),!this._helper&&this._proportionallyResizeElements.length&&this._proportionallyResize(),t.isEmptyObject(s)||(this._updatePrevProperties(),this._trigger("resize",e,this.ui()),this._applyChanges()),!1):!1},_mouseStop:function(e){this.resizing=!1;var i,s,n,o,a,r,h,l=this.options,c=this;return this._helper&&(i=this._proportionallyResizeElements,s=i.length&&/textarea/i.test(i[0].nodeName),n=s&&this._hasScroll(i[0],"left")?0:c.sizeDiff.height,o=s?0:c.sizeDiff.width,a={width:c.helper.width()-o,height:c.helper.height()-n},r=parseFloat(c.element.css("left"))+(c.position.left-c.originalPosition.left)||null,h=parseFloat(c.element.css("top"))+(c.position.top-c.originalPosition.top)||null,l.animate||this.element.css(t.extend(a,{top:h,left:r})),c.helper.height(c.size.height),c.helper.width(c.size.width),this._helper&&!l.animate&&this._proportionallyResize()),t("body").css("cursor","auto"),this._removeClass("ui-resizable-resizing"),this._propagate("stop",e),this._helper&&this.helper.remove(),!1},_updatePrevProperties:function(){this.prevPosition={top:this.position.top,left:this.position.left},this.prevSize={width:this.size.width,height:this.size.height}},_applyChanges:function(){var t={};return this.position.top!==this.prevPosition.top&&(t.top=this.position.top+"px"),this.position.left!==this.prevPosition.left&&(t.left=this.position.left+"px"),this.size.width!==this.prevSize.width&&(t.width=this.size.width+"px"),this.size.height!==this.prevSize.height&&(t.height=this.size.height+"px"),this.helper.css(t),t},_updateVirtualBoundaries:function(t){var e,i,s,n,o,a=this.options;o={minWidth:this._isNumber(a.minWidth)?a.minWidth:0,maxWidth:this._isNumber(a.maxWidth)?a.maxWidth:1/0,minHeight:this._isNumber(a.minHeight)?a.minHeight:0,maxHeight:this._isNumber(a.maxHeight)?a.maxHeight:1/0},(this._aspectRatio||t)&&(e=o.minHeight*this.aspectRatio,s=o.minWidth/this.aspectRatio,i=o.maxHeight*this.aspectRatio,n=o.maxWidth/this.aspectRatio,e>o.minWidth&&(o.minWidth=e),s>o.minHeight&&(o.minHeight=s),o.maxWidth>i&&(o.maxWidth=i),o.maxHeight>n&&(o.maxHeight=n)),this._vBoundaries=o},_updateCache:function(t){this.offset=this.helper.offset(),this._isNumber(t.left)&&(this.position.left=t.left),this._isNumber(t.top)&&(this.position.top=t.top),this._isNumber(t.height)&&(this.size.height=t.height),this._isNumber(t.width)&&(this.size.width=t.width)},_updateRatio:function(t){var e=this.position,i=this.size,s=this.axis;return this._isNumber(t.height)?t.width=t.height*this.aspectRatio:this._isNumber(t.width)&&(t.height=t.width/this.aspectRatio),"sw"===s&&(t.left=e.left+(i.width-t.width),t.top=null),"nw"===s&&(t.top=e.top+(i.height-t.height),t.left=e.left+(i.width-t.width)),t},_respectSize:function(t){var e=this._vBoundaries,i=this.axis,s=this._isNumber(t.width)&&e.maxWidth&&e.maxWidtht.width,a=this._isNumber(t.height)&&e.minHeight&&e.minHeight>t.height,r=this.originalPosition.left+this.originalSize.width,h=this.originalPosition.top+this.originalSize.height,l=/sw|nw|w/.test(i),c=/nw|ne|n/.test(i);return o&&(t.width=e.minWidth),a&&(t.height=e.minHeight),s&&(t.width=e.maxWidth),n&&(t.height=e.maxHeight),o&&l&&(t.left=r-e.minWidth),s&&l&&(t.left=r-e.maxWidth),a&&c&&(t.top=h-e.minHeight),n&&c&&(t.top=h-e.maxHeight),t.width||t.height||t.left||!t.top?t.width||t.height||t.top||!t.left||(t.left=null):t.top=null,t},_getPaddingPlusBorderDimensions:function(t){for(var e=0,i=[],s=[t.css("borderTopWidth"),t.css("borderRightWidth"),t.css("borderBottomWidth"),t.css("borderLeftWidth")],n=[t.css("paddingTop"),t.css("paddingRight"),t.css("paddingBottom"),t.css("paddingLeft")];4>e;e++)i[e]=parseFloat(s[e])||0,i[e]+=parseFloat(n[e])||0;return{height:i[0]+i[2],width:i[1]+i[3]}},_proportionallyResize:function(){if(this._proportionallyResizeElements.length)for(var t,e=0,i=this.helper||this.element;this._proportionallyResizeElements.length>e;e++)t=this._proportionallyResizeElements[e],this.outerDimensions||(this.outerDimensions=this._getPaddingPlusBorderDimensions(t)),t.css({height:i.height()-this.outerDimensions.height||0,width:i.width()-this.outerDimensions.width||0})},_renderProxy:function(){var e=this.element,i=this.options;this.elementOffset=e.offset(),this._helper?(this.helper=this.helper||t("
"),this._addClass(this.helper,this._helper),this.helper.css({width:this.element.outerWidth(),height:this.element.outerHeight(),position:"absolute",left:this.elementOffset.left+"px",top:this.elementOffset.top+"px",zIndex:++i.zIndex}),this.helper.appendTo("body").disableSelection()):this.helper=this.element +},_change:{e:function(t,e){return{width:this.originalSize.width+e}},w:function(t,e){var i=this.originalSize,s=this.originalPosition;return{left:s.left+e,width:i.width-e}},n:function(t,e,i){var s=this.originalSize,n=this.originalPosition;return{top:n.top+i,height:s.height-i}},s:function(t,e,i){return{height:this.originalSize.height+i}},se:function(e,i,s){return t.extend(this._change.s.apply(this,arguments),this._change.e.apply(this,[e,i,s]))},sw:function(e,i,s){return t.extend(this._change.s.apply(this,arguments),this._change.w.apply(this,[e,i,s]))},ne:function(e,i,s){return t.extend(this._change.n.apply(this,arguments),this._change.e.apply(this,[e,i,s]))},nw:function(e,i,s){return t.extend(this._change.n.apply(this,arguments),this._change.w.apply(this,[e,i,s]))}},_propagate:function(e,i){t.ui.plugin.call(this,e,[i,this.ui()]),"resize"!==e&&this._trigger(e,i,this.ui())},plugins:{},ui:function(){return{originalElement:this.originalElement,element:this.element,helper:this.helper,position:this.position,size:this.size,originalSize:this.originalSize,originalPosition:this.originalPosition}}}),t.ui.plugin.add("resizable","animate",{stop:function(e){var i=t(this).resizable("instance"),s=i.options,n=i._proportionallyResizeElements,o=n.length&&/textarea/i.test(n[0].nodeName),a=o&&i._hasScroll(n[0],"left")?0:i.sizeDiff.height,r=o?0:i.sizeDiff.width,h={width:i.size.width-r,height:i.size.height-a},l=parseFloat(i.element.css("left"))+(i.position.left-i.originalPosition.left)||null,c=parseFloat(i.element.css("top"))+(i.position.top-i.originalPosition.top)||null;i.element.animate(t.extend(h,c&&l?{top:c,left:l}:{}),{duration:s.animateDuration,easing:s.animateEasing,step:function(){var s={width:parseFloat(i.element.css("width")),height:parseFloat(i.element.css("height")),top:parseFloat(i.element.css("top")),left:parseFloat(i.element.css("left"))};n&&n.length&&t(n[0]).css({width:s.width,height:s.height}),i._updateCache(s),i._propagate("resize",e)}})}}),t.ui.plugin.add("resizable","containment",{start:function(){var e,i,s,n,o,a,r,h=t(this).resizable("instance"),l=h.options,c=h.element,u=l.containment,d=u instanceof t?u.get(0):/parent/.test(u)?c.parent().get(0):u;d&&(h.containerElement=t(d),/document/.test(u)||u===document?(h.containerOffset={left:0,top:0},h.containerPosition={left:0,top:0},h.parentData={element:t(document),left:0,top:0,width:t(document).width(),height:t(document).height()||document.body.parentNode.scrollHeight}):(e=t(d),i=[],t(["Top","Right","Left","Bottom"]).each(function(t,s){i[t]=h._num(e.css("padding"+s))}),h.containerOffset=e.offset(),h.containerPosition=e.position(),h.containerSize={height:e.innerHeight()-i[3],width:e.innerWidth()-i[1]},s=h.containerOffset,n=h.containerSize.height,o=h.containerSize.width,a=h._hasScroll(d,"left")?d.scrollWidth:o,r=h._hasScroll(d)?d.scrollHeight:n,h.parentData={element:d,left:s.left,top:s.top,width:a,height:r}))},resize:function(e){var i,s,n,o,a=t(this).resizable("instance"),r=a.options,h=a.containerOffset,l=a.position,c=a._aspectRatio||e.shiftKey,u={top:0,left:0},d=a.containerElement,p=!0;d[0]!==document&&/static/.test(d.css("position"))&&(u=h),l.left<(a._helper?h.left:0)&&(a.size.width=a.size.width+(a._helper?a.position.left-h.left:a.position.left-u.left),c&&(a.size.height=a.size.width/a.aspectRatio,p=!1),a.position.left=r.helper?h.left:0),l.top<(a._helper?h.top:0)&&(a.size.height=a.size.height+(a._helper?a.position.top-h.top:a.position.top),c&&(a.size.width=a.size.height*a.aspectRatio,p=!1),a.position.top=a._helper?h.top:0),n=a.containerElement.get(0)===a.element.parent().get(0),o=/relative|absolute/.test(a.containerElement.css("position")),n&&o?(a.offset.left=a.parentData.left+a.position.left,a.offset.top=a.parentData.top+a.position.top):(a.offset.left=a.element.offset().left,a.offset.top=a.element.offset().top),i=Math.abs(a.sizeDiff.width+(a._helper?a.offset.left-u.left:a.offset.left-h.left)),s=Math.abs(a.sizeDiff.height+(a._helper?a.offset.top-u.top:a.offset.top-h.top)),i+a.size.width>=a.parentData.width&&(a.size.width=a.parentData.width-i,c&&(a.size.height=a.size.width/a.aspectRatio,p=!1)),s+a.size.height>=a.parentData.height&&(a.size.height=a.parentData.height-s,c&&(a.size.width=a.size.height*a.aspectRatio,p=!1)),p||(a.position.left=a.prevPosition.left,a.position.top=a.prevPosition.top,a.size.width=a.prevSize.width,a.size.height=a.prevSize.height)},stop:function(){var e=t(this).resizable("instance"),i=e.options,s=e.containerOffset,n=e.containerPosition,o=e.containerElement,a=t(e.helper),r=a.offset(),h=a.outerWidth()-e.sizeDiff.width,l=a.outerHeight()-e.sizeDiff.height;e._helper&&!i.animate&&/relative/.test(o.css("position"))&&t(this).css({left:r.left-n.left-s.left,width:h,height:l}),e._helper&&!i.animate&&/static/.test(o.css("position"))&&t(this).css({left:r.left-n.left-s.left,width:h,height:l})}}),t.ui.plugin.add("resizable","alsoResize",{start:function(){var e=t(this).resizable("instance"),i=e.options;t(i.alsoResize).each(function(){var e=t(this);e.data("ui-resizable-alsoresize",{width:parseFloat(e.width()),height:parseFloat(e.height()),left:parseFloat(e.css("left")),top:parseFloat(e.css("top"))})})},resize:function(e,i){var s=t(this).resizable("instance"),n=s.options,o=s.originalSize,a=s.originalPosition,r={height:s.size.height-o.height||0,width:s.size.width-o.width||0,top:s.position.top-a.top||0,left:s.position.left-a.left||0};t(n.alsoResize).each(function(){var e=t(this),s=t(this).data("ui-resizable-alsoresize"),n={},o=e.parents(i.originalElement[0]).length?["width","height"]:["width","height","top","left"];t.each(o,function(t,e){var i=(s[e]||0)+(r[e]||0);i&&i>=0&&(n[e]=i||null)}),e.css(n)})},stop:function(){t(this).removeData("ui-resizable-alsoresize")}}),t.ui.plugin.add("resizable","ghost",{start:function(){var e=t(this).resizable("instance"),i=e.size;e.ghost=e.originalElement.clone(),e.ghost.css({opacity:.25,display:"block",position:"relative",height:i.height,width:i.width,margin:0,left:0,top:0}),e._addClass(e.ghost,"ui-resizable-ghost"),t.uiBackCompat!==!1&&"string"==typeof e.options.ghost&&e.ghost.addClass(this.options.ghost),e.ghost.appendTo(e.helper)},resize:function(){var e=t(this).resizable("instance");e.ghost&&e.ghost.css({position:"relative",height:e.size.height,width:e.size.width})},stop:function(){var e=t(this).resizable("instance");e.ghost&&e.helper&&e.helper.get(0).removeChild(e.ghost.get(0))}}),t.ui.plugin.add("resizable","grid",{resize:function(){var e,i=t(this).resizable("instance"),s=i.options,n=i.size,o=i.originalSize,a=i.originalPosition,r=i.axis,h="number"==typeof s.grid?[s.grid,s.grid]:s.grid,l=h[0]||1,c=h[1]||1,u=Math.round((n.width-o.width)/l)*l,d=Math.round((n.height-o.height)/c)*c,p=o.width+u,f=o.height+d,m=s.maxWidth&&p>s.maxWidth,g=s.maxHeight&&f>s.maxHeight,_=s.minWidth&&s.minWidth>p,v=s.minHeight&&s.minHeight>f;s.grid=h,_&&(p+=l),v&&(f+=c),m&&(p-=l),g&&(f-=c),/^(se|s|e)$/.test(r)?(i.size.width=p,i.size.height=f):/^(ne)$/.test(r)?(i.size.width=p,i.size.height=f,i.position.top=a.top-d):/^(sw)$/.test(r)?(i.size.width=p,i.size.height=f,i.position.left=a.left-u):((0>=f-c||0>=p-l)&&(e=i._getPaddingPlusBorderDimensions(this)),f-c>0?(i.size.height=f,i.position.top=a.top-d):(f=c-e.height,i.size.height=f,i.position.top=a.top+o.height-f),p-l>0?(i.size.width=p,i.position.left=a.left-u):(p=l-e.width,i.size.width=p,i.position.left=a.left+o.width-p))}}),t.ui.resizable});/** + * Copyright (c) 2007 Ariel Flesler - aflesler ○ gmail • com | https://github.com/flesler + * Licensed under MIT + * @author Ariel Flesler + * @version 2.1.2 + */ +;(function(f){"use strict";"function"===typeof define&&define.amd?define(["jquery"],f):"undefined"!==typeof module&&module.exports?module.exports=f(require("jquery")):f(jQuery)})(function($){"use strict";function n(a){return!a.nodeName||-1!==$.inArray(a.nodeName.toLowerCase(),["iframe","#document","html","body"])}function h(a){return $.isFunction(a)||$.isPlainObject(a)?a:{top:a,left:a}}var p=$.scrollTo=function(a,d,b){return $(window).scrollTo(a,d,b)};p.defaults={axis:"xy",duration:0,limit:!0};$.fn.scrollTo=function(a,d,b){"object"=== typeof d&&(b=d,d=0);"function"===typeof b&&(b={onAfter:b});"max"===a&&(a=9E9);b=$.extend({},p.defaults,b);d=d||b.duration;var u=b.queue&&1=f[g]?0:Math.min(f[g],n));!a&&1-1){targetElements.on(evt+EVENT_NAMESPACE,function elementToggle(event){$.powerTip.toggle(this,event)})}else{targetElements.on(evt+EVENT_NAMESPACE,function elementOpen(event){$.powerTip.show(this,event)})}});$.each(options.closeEvents,function(idx,evt){if($.inArray(evt,options.openEvents)<0){targetElements.on(evt+EVENT_NAMESPACE,function elementClose(event){$.powerTip.hide(this,!isMouseEvent(event))})}});targetElements.on("keydown"+EVENT_NAMESPACE,function elementKeyDown(event){if(event.keyCode===27){$.powerTip.hide(this,true)}})}return targetElements};$.fn.powerTip.defaults={fadeInTime:200,fadeOutTime:100,followMouse:false,popupId:"powerTip",popupClass:null,intentSensitivity:7,intentPollInterval:100,closeDelay:100,placement:"n",smartPlacement:false,offset:10,mouseOnToPopup:false,manual:false,openEvents:["mouseenter","focus"],closeEvents:["mouseleave","blur"]};$.fn.powerTip.smartPlacementLists={n:["n","ne","nw","s"],e:["e","ne","se","w","nw","sw","n","s","e"],s:["s","se","sw","n"],w:["w","nw","sw","e","ne","se","n","s","w"],nw:["nw","w","sw","n","s","se","nw"],ne:["ne","e","se","n","s","sw","ne"],sw:["sw","w","nw","s","n","ne","sw"],se:["se","e","ne","s","n","nw","se"],"nw-alt":["nw-alt","n","ne-alt","sw-alt","s","se-alt","w","e"],"ne-alt":["ne-alt","n","nw-alt","se-alt","s","sw-alt","e","w"],"sw-alt":["sw-alt","s","se-alt","nw-alt","n","ne-alt","w","e"],"se-alt":["se-alt","s","sw-alt","ne-alt","n","nw-alt","e","w"]};$.powerTip={show:function apiShowTip(element,event){if(isMouseEvent(event)){trackMouse(event);session.previousX=event.pageX;session.previousY=event.pageY;$(element).data(DATA_DISPLAYCONTROLLER).show()}else{$(element).first().data(DATA_DISPLAYCONTROLLER).show(true,true)}return element},reposition:function apiResetPosition(element){$(element).first().data(DATA_DISPLAYCONTROLLER).resetPosition();return element},hide:function apiCloseTip(element,immediate){var displayController;immediate=element?immediate:true;if(element){displayController=$(element).first().data(DATA_DISPLAYCONTROLLER)}else if(session.activeHover){displayController=session.activeHover.data(DATA_DISPLAYCONTROLLER)}if(displayController){displayController.hide(immediate)}return element},toggle:function apiToggle(element,event){if(session.activeHover&&session.activeHover.is(element)){$.powerTip.hide(element,!isMouseEvent(event))}else{$.powerTip.show(element,event)}return element}};$.powerTip.showTip=$.powerTip.show;$.powerTip.closeTip=$.powerTip.hide;function CSSCoordinates(){var me=this;me.top="auto";me.left="auto";me.right="auto";me.bottom="auto";me.set=function(property,value){if($.isNumeric(value)){me[property]=Math.round(value)}}}function DisplayController(element,options,tipController){var hoverTimer=null,myCloseDelay=null;function openTooltip(immediate,forceOpen){cancelTimer();if(!element.data(DATA_HASACTIVEHOVER)){if(!immediate){session.tipOpenImminent=true;hoverTimer=setTimeout(function intentDelay(){hoverTimer=null;checkForIntent()},options.intentPollInterval)}else{if(forceOpen){element.data(DATA_FORCEDOPEN,true)}closeAnyDelayed();tipController.showTip(element)}}else{cancelClose()}}function closeTooltip(disableDelay){if(myCloseDelay){myCloseDelay=session.closeDelayTimeout=clearTimeout(myCloseDelay);session.delayInProgress=false}cancelTimer();session.tipOpenImminent=false;if(element.data(DATA_HASACTIVEHOVER)){element.data(DATA_FORCEDOPEN,false);if(!disableDelay){session.delayInProgress=true;session.closeDelayTimeout=setTimeout(function closeDelay(){session.closeDelayTimeout=null;tipController.hideTip(element);session.delayInProgress=false;myCloseDelay=null},options.closeDelay);myCloseDelay=session.closeDelayTimeout}else{tipController.hideTip(element)}}}function checkForIntent(){var xDifference=Math.abs(session.previousX-session.currentX),yDifference=Math.abs(session.previousY-session.currentY),totalDifference=xDifference+yDifference;if(totalDifference",{id:options.popupId});if($body.length===0){$body=$("body")}$body.append(tipElement);session.tooltips=session.tooltips?session.tooltips.add(tipElement):tipElement}if(options.followMouse){if(!tipElement.data(DATA_HASMOUSEMOVE)){$document.on("mousemove"+EVENT_NAMESPACE,positionTipOnCursor);$window.on("scroll"+EVENT_NAMESPACE,positionTipOnCursor);tipElement.data(DATA_HASMOUSEMOVE,true)}}function beginShowTip(element){element.data(DATA_HASACTIVEHOVER,true);tipElement.queue(function queueTipInit(next){showTip(element);next()})}function showTip(element){var tipContent;if(!element.data(DATA_HASACTIVEHOVER)){return}if(session.isTipOpen){if(!session.isClosing){hideTip(session.activeHover)}tipElement.delay(100).queue(function queueTipAgain(next){showTip(element);next()});return}element.trigger("powerTipPreRender");tipContent=getTooltipContent(element);if(tipContent){tipElement.empty().append(tipContent)}else{return}element.trigger("powerTipRender");session.activeHover=element;session.isTipOpen=true;tipElement.data(DATA_MOUSEONTOTIP,options.mouseOnToPopup);tipElement.addClass(options.popupClass);if(!options.followMouse||element.data(DATA_FORCEDOPEN)){positionTipOnElement(element);session.isFixedTipOpen=true}else{positionTipOnCursor()}if(!element.data(DATA_FORCEDOPEN)&&!options.followMouse){$document.on("click"+EVENT_NAMESPACE,function documentClick(event){var target=event.target;if(target!==element[0]){if(options.mouseOnToPopup){if(target!==tipElement[0]&&!$.contains(tipElement[0],target)){$.powerTip.hide()}}else{$.powerTip.hide()}}})}if(options.mouseOnToPopup&&!options.manual){tipElement.on("mouseenter"+EVENT_NAMESPACE,function tipMouseEnter(){if(session.activeHover){session.activeHover.data(DATA_DISPLAYCONTROLLER).cancel()}});tipElement.on("mouseleave"+EVENT_NAMESPACE,function tipMouseLeave(){if(session.activeHover){session.activeHover.data(DATA_DISPLAYCONTROLLER).hide()}})}tipElement.fadeIn(options.fadeInTime,function fadeInCallback(){if(!session.desyncTimeout){session.desyncTimeout=setInterval(closeDesyncedTip,500)}element.trigger("powerTipOpen")})}function hideTip(element){session.isClosing=true;session.isTipOpen=false;session.desyncTimeout=clearInterval(session.desyncTimeout);element.data(DATA_HASACTIVEHOVER,false);element.data(DATA_FORCEDOPEN,false);$document.off("click"+EVENT_NAMESPACE);tipElement.off(EVENT_NAMESPACE);tipElement.fadeOut(options.fadeOutTime,function fadeOutCallback(){var coords=new CSSCoordinates;session.activeHover=null;session.isClosing=false;session.isFixedTipOpen=false;tipElement.removeClass();coords.set("top",session.currentY+options.offset);coords.set("left",session.currentX+options.offset);tipElement.css(coords);element.trigger("powerTipClose")})}function positionTipOnCursor(){var tipWidth,tipHeight,coords,collisions,collisionCount;if(!session.isFixedTipOpen&&(session.isTipOpen||session.tipOpenImminent&&tipElement.data(DATA_HASMOUSEMOVE))){tipWidth=tipElement.outerWidth();tipHeight=tipElement.outerHeight();coords=new CSSCoordinates;coords.set("top",session.currentY+options.offset);coords.set("left",session.currentX+options.offset);collisions=getViewportCollisions(coords,tipWidth,tipHeight);if(collisions!==Collision.none){collisionCount=countFlags(collisions);if(collisionCount===1){if(collisions===Collision.right){coords.set("left",session.scrollLeft+session.windowWidth-tipWidth)}else if(collisions===Collision.bottom){coords.set("top",session.scrollTop+session.windowHeight-tipHeight)}}else{coords.set("left",session.currentX-tipWidth-options.offset);coords.set("top",session.currentY-tipHeight-options.offset)}}tipElement.css(coords)}}function positionTipOnElement(element){var priorityList,finalPlacement;if(options.smartPlacement||options.followMouse&&element.data(DATA_FORCEDOPEN)){priorityList=$.fn.powerTip.smartPlacementLists[options.placement];$.each(priorityList,function(idx,pos){var collisions=getViewportCollisions(placeTooltip(element,pos),tipElement.outerWidth(),tipElement.outerHeight());finalPlacement=pos;return collisions!==Collision.none})}else{placeTooltip(element,options.placement);finalPlacement=options.placement}tipElement.removeClass("w nw sw e ne se n s w se-alt sw-alt ne-alt nw-alt");tipElement.addClass(finalPlacement)}function placeTooltip(element,placement){var iterationCount=0,tipWidth,tipHeight,coords=new CSSCoordinates;coords.set("top",0);coords.set("left",0);tipElement.css(coords);do{tipWidth=tipElement.outerWidth();tipHeight=tipElement.outerHeight();coords=placementCalculator.compute(element,placement,tipWidth,tipHeight,options.offset);tipElement.css(coords)}while(++iterationCount<=5&&(tipWidth!==tipElement.outerWidth()||tipHeight!==tipElement.outerHeight()));return coords}function closeDesyncedTip(){var isDesynced=false,hasDesyncableCloseEvent=$.grep(["mouseleave","mouseout","blur","focusout"],function(eventType){return $.inArray(eventType,options.closeEvents)!==-1}).length>0;if(session.isTipOpen&&!session.isClosing&&!session.delayInProgress&&hasDesyncableCloseEvent){if(session.activeHover.data(DATA_HASACTIVEHOVER)===false||session.activeHover.is(":disabled")){isDesynced=true}else if(!isMouseOver(session.activeHover)&&!session.activeHover.is(":focus")&&!session.activeHover.data(DATA_FORCEDOPEN)){if(tipElement.data(DATA_MOUSEONTOTIP)){if(!isMouseOver(tipElement)){isDesynced=true}}else{isDesynced=true}}if(isDesynced){hideTip(session.activeHover)}}}this.showTip=beginShowTip;this.hideTip=hideTip;this.resetPosition=positionTipOnElement}function isSvgElement(element){return Boolean(window.SVGElement&&element[0]instanceof SVGElement)}function isMouseEvent(event){return Boolean(event&&$.inArray(event.type,MOUSE_EVENTS)>-1&&typeof event.pageX==="number")}function initTracking(){if(!session.mouseTrackingActive){session.mouseTrackingActive=true;getViewportDimensions();$(getViewportDimensions);$document.on("mousemove"+EVENT_NAMESPACE,trackMouse);$window.on("resize"+EVENT_NAMESPACE,trackResize);$window.on("scroll"+EVENT_NAMESPACE,trackScroll)}}function getViewportDimensions(){session.scrollLeft=$window.scrollLeft();session.scrollTop=$window.scrollTop();session.windowWidth=$window.width();session.windowHeight=$window.height()}function trackResize(){session.windowWidth=$window.width();session.windowHeight=$window.height()}function trackScroll(){var x=$window.scrollLeft(),y=$window.scrollTop();if(x!==session.scrollLeft){session.currentX+=x-session.scrollLeft;session.scrollLeft=x}if(y!==session.scrollTop){session.currentY+=y-session.scrollTop;session.scrollTop=y}}function trackMouse(event){session.currentX=event.pageX;session.currentY=event.pageY}function isMouseOver(element){var elementPosition=element.offset(),elementBox=element[0].getBoundingClientRect(),elementWidth=elementBox.right-elementBox.left,elementHeight=elementBox.bottom-elementBox.top;return session.currentX>=elementPosition.left&&session.currentX<=elementPosition.left+elementWidth&&session.currentY>=elementPosition.top&&session.currentY<=elementPosition.top+elementHeight}function getTooltipContent(element){var tipText=element.data(DATA_POWERTIP),tipObject=element.data(DATA_POWERTIPJQ),tipTarget=element.data(DATA_POWERTIPTARGET),targetElement,content;if(tipText){if($.isFunction(tipText)){tipText=tipText.call(element[0])}content=tipText}else if(tipObject){if($.isFunction(tipObject)){tipObject=tipObject.call(element[0])}if(tipObject.length>0){content=tipObject.clone(true,true)}}else if(tipTarget){targetElement=$("#"+tipTarget);if(targetElement.length>0){content=targetElement.html()}}return content}function getViewportCollisions(coords,elementWidth,elementHeight){var viewportTop=session.scrollTop,viewportLeft=session.scrollLeft,viewportBottom=viewportTop+session.windowHeight,viewportRight=viewportLeft+session.windowWidth,collisions=Collision.none;if(coords.topviewportBottom||Math.abs(coords.bottom-session.windowHeight)>viewportBottom){collisions|=Collision.bottom}if(coords.leftviewportRight){collisions|=Collision.left}if(coords.left+elementWidth>viewportRight||coords.right1)){a.preventDefault();var c=a.originalEvent.changedTouches[0],d=document.createEvent("MouseEvents");d.initMouseEvent(b,!0,!0,window,1,c.screenX,c.screenY,c.clientX,c.clientY,!1,!1,!1,!1,0,null),a.target.dispatchEvent(d)}}if(a.support.touch="ontouchend"in document,a.support.touch){var e,b=a.ui.mouse.prototype,c=b._mouseInit,d=b._mouseDestroy;b._touchStart=function(a){var b=this;!e&&b._mouseCapture(a.originalEvent.changedTouches[0])&&(e=!0,b._touchMoved=!1,f(a,"mouseover"),f(a,"mousemove"),f(a,"mousedown"))},b._touchMove=function(a){e&&(this._touchMoved=!0,f(a,"mousemove"))},b._touchEnd=function(a){e&&(f(a,"mouseup"),f(a,"mouseout"),this._touchMoved||f(a,"click"),e=!1)},b._mouseInit=function(){var b=this;b.element.bind({touchstart:a.proxy(b,"_touchStart"),touchmove:a.proxy(b,"_touchMove"),touchend:a.proxy(b,"_touchEnd")}),c.call(b)},b._mouseDestroy=function(){var b=this;b.element.unbind({touchstart:a.proxy(b,"_touchStart"),touchmove:a.proxy(b,"_touchMove"),touchend:a.proxy(b,"_touchEnd")}),d.call(b)}}}(jQuery);/*! SmartMenus jQuery Plugin - v1.1.0 - September 17, 2017 + * http://www.smartmenus.org/ + * Copyright Vasil Dinkov, Vadikom Web Ltd. http://vadikom.com; Licensed MIT */(function(t){"function"==typeof define&&define.amd?define(["jquery"],t):"object"==typeof module&&"object"==typeof module.exports?module.exports=t(require("jquery")):t(jQuery)})(function($){function initMouseDetection(t){var e=".smartmenus_mouse";if(mouseDetectionEnabled||t)mouseDetectionEnabled&&t&&($(document).off(e),mouseDetectionEnabled=!1);else{var i=!0,s=null,o={mousemove:function(t){var e={x:t.pageX,y:t.pageY,timeStamp:(new Date).getTime()};if(s){var o=Math.abs(s.x-e.x),a=Math.abs(s.y-e.y);if((o>0||a>0)&&2>=o&&2>=a&&300>=e.timeStamp-s.timeStamp&&(mouse=!0,i)){var n=$(t.target).closest("a");n.is("a")&&$.each(menuTrees,function(){return $.contains(this.$root[0],n[0])?(this.itemEnter({currentTarget:n[0]}),!1):void 0}),i=!1}}s=e}};o[touchEvents?"touchstart":"pointerover pointermove pointerout MSPointerOver MSPointerMove MSPointerOut"]=function(t){isTouchEvent(t.originalEvent)&&(mouse=!1)},$(document).on(getEventsNS(o,e)),mouseDetectionEnabled=!0}}function isTouchEvent(t){return!/^(4|mouse)$/.test(t.pointerType)}function getEventsNS(t,e){e||(e="");var i={};for(var s in t)i[s.split(" ").join(e+" ")+e]=t[s];return i}var menuTrees=[],mouse=!1,touchEvents="ontouchstart"in window,mouseDetectionEnabled=!1,requestAnimationFrame=window.requestAnimationFrame||function(t){return setTimeout(t,1e3/60)},cancelAnimationFrame=window.cancelAnimationFrame||function(t){clearTimeout(t)},canAnimate=!!$.fn.animate;return $.SmartMenus=function(t,e){this.$root=$(t),this.opts=e,this.rootId="",this.accessIdPrefix="",this.$subArrow=null,this.activatedItems=[],this.visibleSubMenus=[],this.showTimeout=0,this.hideTimeout=0,this.scrollTimeout=0,this.clickActivated=!1,this.focusActivated=!1,this.zIndexInc=0,this.idInc=0,this.$firstLink=null,this.$firstSub=null,this.disabled=!1,this.$disableOverlay=null,this.$touchScrollingSub=null,this.cssTransforms3d="perspective"in t.style||"webkitPerspective"in t.style,this.wasCollapsible=!1,this.init()},$.extend($.SmartMenus,{hideAll:function(){$.each(menuTrees,function(){this.menuHideAll()})},destroy:function(){for(;menuTrees.length;)menuTrees[0].destroy();initMouseDetection(!0)},prototype:{init:function(t){var e=this;if(!t){menuTrees.push(this),this.rootId=((new Date).getTime()+Math.random()+"").replace(/\D/g,""),this.accessIdPrefix="sm-"+this.rootId+"-",this.$root.hasClass("sm-rtl")&&(this.opts.rightToLeftSubMenus=!0);var i=".smartmenus";this.$root.data("smartmenus",this).attr("data-smartmenus-id",this.rootId).dataSM("level",1).on(getEventsNS({"mouseover focusin":$.proxy(this.rootOver,this),"mouseout focusout":$.proxy(this.rootOut,this),keydown:$.proxy(this.rootKeyDown,this)},i)).on(getEventsNS({mouseenter:$.proxy(this.itemEnter,this),mouseleave:$.proxy(this.itemLeave,this),mousedown:$.proxy(this.itemDown,this),focus:$.proxy(this.itemFocus,this),blur:$.proxy(this.itemBlur,this),click:$.proxy(this.itemClick,this)},i),"a"),i+=this.rootId,this.opts.hideOnClick&&$(document).on(getEventsNS({touchstart:$.proxy(this.docTouchStart,this),touchmove:$.proxy(this.docTouchMove,this),touchend:$.proxy(this.docTouchEnd,this),click:$.proxy(this.docClick,this)},i)),$(window).on(getEventsNS({"resize orientationchange":$.proxy(this.winResize,this)},i)),this.opts.subIndicators&&(this.$subArrow=$("").addClass("sub-arrow"),this.opts.subIndicatorsText&&this.$subArrow.html(this.opts.subIndicatorsText)),initMouseDetection()}if(this.$firstSub=this.$root.find("ul").each(function(){e.menuInit($(this))}).eq(0),this.$firstLink=this.$root.find("a").eq(0),this.opts.markCurrentItem){var s=/(index|default)\.[^#\?\/]*/i,o=/#.*/,a=window.location.href.replace(s,""),n=a.replace(o,"");this.$root.find("a").each(function(){var t=this.href.replace(s,""),i=$(this);(t==a||t==n)&&(i.addClass("current"),e.opts.markCurrentTree&&i.parentsUntil("[data-smartmenus-id]","ul").each(function(){$(this).dataSM("parent-a").addClass("current")}))})}this.wasCollapsible=this.isCollapsible()},destroy:function(t){if(!t){var e=".smartmenus";this.$root.removeData("smartmenus").removeAttr("data-smartmenus-id").removeDataSM("level").off(e),e+=this.rootId,$(document).off(e),$(window).off(e),this.opts.subIndicators&&(this.$subArrow=null)}this.menuHideAll();var i=this;this.$root.find("ul").each(function(){var t=$(this);t.dataSM("scroll-arrows")&&t.dataSM("scroll-arrows").remove(),t.dataSM("shown-before")&&((i.opts.subMenusMinWidth||i.opts.subMenusMaxWidth)&&t.css({width:"",minWidth:"",maxWidth:""}).removeClass("sm-nowrap"),t.dataSM("scroll-arrows")&&t.dataSM("scroll-arrows").remove(),t.css({zIndex:"",top:"",left:"",marginLeft:"",marginTop:"",display:""})),0==(t.attr("id")||"").indexOf(i.accessIdPrefix)&&t.removeAttr("id")}).removeDataSM("in-mega").removeDataSM("shown-before").removeDataSM("scroll-arrows").removeDataSM("parent-a").removeDataSM("level").removeDataSM("beforefirstshowfired").removeAttr("role").removeAttr("aria-hidden").removeAttr("aria-labelledby").removeAttr("aria-expanded"),this.$root.find("a.has-submenu").each(function(){var t=$(this);0==t.attr("id").indexOf(i.accessIdPrefix)&&t.removeAttr("id")}).removeClass("has-submenu").removeDataSM("sub").removeAttr("aria-haspopup").removeAttr("aria-controls").removeAttr("aria-expanded").closest("li").removeDataSM("sub"),this.opts.subIndicators&&this.$root.find("span.sub-arrow").remove(),this.opts.markCurrentItem&&this.$root.find("a.current").removeClass("current"),t||(this.$root=null,this.$firstLink=null,this.$firstSub=null,this.$disableOverlay&&(this.$disableOverlay.remove(),this.$disableOverlay=null),menuTrees.splice($.inArray(this,menuTrees),1))},disable:function(t){if(!this.disabled){if(this.menuHideAll(),!t&&!this.opts.isPopup&&this.$root.is(":visible")){var e=this.$root.offset();this.$disableOverlay=$('
').css({position:"absolute",top:e.top,left:e.left,width:this.$root.outerWidth(),height:this.$root.outerHeight(),zIndex:this.getStartZIndex(!0),opacity:0}).appendTo(document.body)}this.disabled=!0}},docClick:function(t){return this.$touchScrollingSub?(this.$touchScrollingSub=null,void 0):((this.visibleSubMenus.length&&!$.contains(this.$root[0],t.target)||$(t.target).closest("a").length)&&this.menuHideAll(),void 0)},docTouchEnd:function(){if(this.lastTouch){if(!(!this.visibleSubMenus.length||void 0!==this.lastTouch.x2&&this.lastTouch.x1!=this.lastTouch.x2||void 0!==this.lastTouch.y2&&this.lastTouch.y1!=this.lastTouch.y2||this.lastTouch.target&&$.contains(this.$root[0],this.lastTouch.target))){this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0);var t=this;this.hideTimeout=setTimeout(function(){t.menuHideAll()},350)}this.lastTouch=null}},docTouchMove:function(t){if(this.lastTouch){var e=t.originalEvent.touches[0];this.lastTouch.x2=e.pageX,this.lastTouch.y2=e.pageY}},docTouchStart:function(t){var e=t.originalEvent.touches[0];this.lastTouch={x1:e.pageX,y1:e.pageY,target:e.target}},enable:function(){this.disabled&&(this.$disableOverlay&&(this.$disableOverlay.remove(),this.$disableOverlay=null),this.disabled=!1)},getClosestMenu:function(t){for(var e=$(t).closest("ul");e.dataSM("in-mega");)e=e.parent().closest("ul");return e[0]||null},getHeight:function(t){return this.getOffset(t,!0)},getOffset:function(t,e){var i;"none"==t.css("display")&&(i={position:t[0].style.position,visibility:t[0].style.visibility},t.css({position:"absolute",visibility:"hidden"}).show());var s=t[0].getBoundingClientRect&&t[0].getBoundingClientRect(),o=s&&(e?s.height||s.bottom-s.top:s.width||s.right-s.left);return o||0===o||(o=e?t[0].offsetHeight:t[0].offsetWidth),i&&t.hide().css(i),o},getStartZIndex:function(t){var e=parseInt(this[t?"$root":"$firstSub"].css("z-index"));return!t&&isNaN(e)&&(e=parseInt(this.$root.css("z-index"))),isNaN(e)?1:e},getTouchPoint:function(t){return t.touches&&t.touches[0]||t.changedTouches&&t.changedTouches[0]||t},getViewport:function(t){var e=t?"Height":"Width",i=document.documentElement["client"+e],s=window["inner"+e];return s&&(i=Math.min(i,s)),i},getViewportHeight:function(){return this.getViewport(!0)},getViewportWidth:function(){return this.getViewport()},getWidth:function(t){return this.getOffset(t)},handleEvents:function(){return!this.disabled&&this.isCSSOn()},handleItemEvents:function(t){return this.handleEvents()&&!this.isLinkInMegaMenu(t)},isCollapsible:function(){return"static"==this.$firstSub.css("position")},isCSSOn:function(){return"inline"!=this.$firstLink.css("display")},isFixed:function(){var t="fixed"==this.$root.css("position");return t||this.$root.parentsUntil("body").each(function(){return"fixed"==$(this).css("position")?(t=!0,!1):void 0}),t},isLinkInMegaMenu:function(t){return $(this.getClosestMenu(t[0])).hasClass("mega-menu")},isTouchMode:function(){return!mouse||this.opts.noMouseOver||this.isCollapsible()},itemActivate:function(t,e){var i=t.closest("ul"),s=i.dataSM("level");if(s>1&&(!this.activatedItems[s-2]||this.activatedItems[s-2][0]!=i.dataSM("parent-a")[0])){var o=this;$(i.parentsUntil("[data-smartmenus-id]","ul").get().reverse()).add(i).each(function(){o.itemActivate($(this).dataSM("parent-a"))})}if((!this.isCollapsible()||e)&&this.menuHideSubMenus(this.activatedItems[s-1]&&this.activatedItems[s-1][0]==t[0]?s:s-1),this.activatedItems[s-1]=t,this.$root.triggerHandler("activate.smapi",t[0])!==!1){var a=t.dataSM("sub");a&&(this.isTouchMode()||!this.opts.showOnClick||this.clickActivated)&&this.menuShow(a)}},itemBlur:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&this.$root.triggerHandler("blur.smapi",e[0])},itemClick:function(t){var e=$(t.currentTarget);if(this.handleItemEvents(e)){if(this.$touchScrollingSub&&this.$touchScrollingSub[0]==e.closest("ul")[0])return this.$touchScrollingSub=null,t.stopPropagation(),!1;if(this.$root.triggerHandler("click.smapi",e[0])===!1)return!1;var i=$(t.target).is(".sub-arrow"),s=e.dataSM("sub"),o=s?2==s.dataSM("level"):!1,a=this.isCollapsible(),n=/toggle$/.test(this.opts.collapsibleBehavior),r=/link$/.test(this.opts.collapsibleBehavior),h=/^accordion/.test(this.opts.collapsibleBehavior);if(s&&!s.is(":visible")){if((!r||!a||i)&&(this.opts.showOnClick&&o&&(this.clickActivated=!0),this.itemActivate(e,h),s.is(":visible")))return this.focusActivated=!0,!1}else if(a&&(n||i))return this.itemActivate(e,h),this.menuHide(s),n&&(this.focusActivated=!1),!1;return this.opts.showOnClick&&o||e.hasClass("disabled")||this.$root.triggerHandler("select.smapi",e[0])===!1?!1:void 0}},itemDown:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&e.dataSM("mousedown",!0)},itemEnter:function(t){var e=$(t.currentTarget);if(this.handleItemEvents(e)){if(!this.isTouchMode()){this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0);var i=this;this.showTimeout=setTimeout(function(){i.itemActivate(e)},this.opts.showOnClick&&1==e.closest("ul").dataSM("level")?1:this.opts.showTimeout)}this.$root.triggerHandler("mouseenter.smapi",e[0])}},itemFocus:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&(!this.focusActivated||this.isTouchMode()&&e.dataSM("mousedown")||this.activatedItems.length&&this.activatedItems[this.activatedItems.length-1][0]==e[0]||this.itemActivate(e,!0),this.$root.triggerHandler("focus.smapi",e[0]))},itemLeave:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&(this.isTouchMode()||(e[0].blur(),this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0)),e.removeDataSM("mousedown"),this.$root.triggerHandler("mouseleave.smapi",e[0]))},menuHide:function(t){if(this.$root.triggerHandler("beforehide.smapi",t[0])!==!1&&(canAnimate&&t.stop(!0,!0),"none"!=t.css("display"))){var e=function(){t.css("z-index","")};this.isCollapsible()?canAnimate&&this.opts.collapsibleHideFunction?this.opts.collapsibleHideFunction.call(this,t,e):t.hide(this.opts.collapsibleHideDuration,e):canAnimate&&this.opts.hideFunction?this.opts.hideFunction.call(this,t,e):t.hide(this.opts.hideDuration,e),t.dataSM("scroll")&&(this.menuScrollStop(t),t.css({"touch-action":"","-ms-touch-action":"","-webkit-transform":"",transform:""}).off(".smartmenus_scroll").removeDataSM("scroll").dataSM("scroll-arrows").hide()),t.dataSM("parent-a").removeClass("highlighted").attr("aria-expanded","false"),t.attr({"aria-expanded":"false","aria-hidden":"true"});var i=t.dataSM("level");this.activatedItems.splice(i-1,1),this.visibleSubMenus.splice($.inArray(t,this.visibleSubMenus),1),this.$root.triggerHandler("hide.smapi",t[0])}},menuHideAll:function(){this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0);for(var t=this.opts.isPopup?1:0,e=this.visibleSubMenus.length-1;e>=t;e--)this.menuHide(this.visibleSubMenus[e]);this.opts.isPopup&&(canAnimate&&this.$root.stop(!0,!0),this.$root.is(":visible")&&(canAnimate&&this.opts.hideFunction?this.opts.hideFunction.call(this,this.$root):this.$root.hide(this.opts.hideDuration))),this.activatedItems=[],this.visibleSubMenus=[],this.clickActivated=!1,this.focusActivated=!1,this.zIndexInc=0,this.$root.triggerHandler("hideAll.smapi")},menuHideSubMenus:function(t){for(var e=this.activatedItems.length-1;e>=t;e--){var i=this.activatedItems[e].dataSM("sub");i&&this.menuHide(i)}},menuInit:function(t){if(!t.dataSM("in-mega")){t.hasClass("mega-menu")&&t.find("ul").dataSM("in-mega",!0);for(var e=2,i=t[0];(i=i.parentNode.parentNode)!=this.$root[0];)e++;var s=t.prevAll("a").eq(-1);s.length||(s=t.prevAll().find("a").eq(-1)),s.addClass("has-submenu").dataSM("sub",t),t.dataSM("parent-a",s).dataSM("level",e).parent().dataSM("sub",t);var o=s.attr("id")||this.accessIdPrefix+ ++this.idInc,a=t.attr("id")||this.accessIdPrefix+ ++this.idInc;s.attr({id:o,"aria-haspopup":"true","aria-controls":a,"aria-expanded":"false"}),t.attr({id:a,role:"group","aria-hidden":"true","aria-labelledby":o,"aria-expanded":"false"}),this.opts.subIndicators&&s[this.opts.subIndicatorsPos](this.$subArrow.clone())}},menuPosition:function(t){var e,i,s=t.dataSM("parent-a"),o=s.closest("li"),a=o.parent(),n=t.dataSM("level"),r=this.getWidth(t),h=this.getHeight(t),u=s.offset(),l=u.left,c=u.top,d=this.getWidth(s),m=this.getHeight(s),p=$(window),f=p.scrollLeft(),v=p.scrollTop(),b=this.getViewportWidth(),S=this.getViewportHeight(),g=a.parent().is("[data-sm-horizontal-sub]")||2==n&&!a.hasClass("sm-vertical"),M=this.opts.rightToLeftSubMenus&&!o.is("[data-sm-reverse]")||!this.opts.rightToLeftSubMenus&&o.is("[data-sm-reverse]"),w=2==n?this.opts.mainMenuSubOffsetX:this.opts.subMenusSubOffsetX,T=2==n?this.opts.mainMenuSubOffsetY:this.opts.subMenusSubOffsetY;if(g?(e=M?d-r-w:w,i=this.opts.bottomToTopSubMenus?-h-T:m+T):(e=M?w-r:d-w,i=this.opts.bottomToTopSubMenus?m-T-h:T),this.opts.keepInViewport){var y=l+e,I=c+i;if(M&&f>y?e=g?f-y+e:d-w:!M&&y+r>f+b&&(e=g?f+b-r-y+e:w-r),g||(S>h&&I+h>v+S?i+=v+S-h-I:(h>=S||v>I)&&(i+=v-I)),g&&(I+h>v+S+.49||v>I)||!g&&h>S+.49){var x=this;t.dataSM("scroll-arrows")||t.dataSM("scroll-arrows",$([$('')[0],$('')[0]]).on({mouseenter:function(){t.dataSM("scroll").up=$(this).hasClass("scroll-up"),x.menuScroll(t)},mouseleave:function(e){x.menuScrollStop(t),x.menuScrollOut(t,e)},"mousewheel DOMMouseScroll":function(t){t.preventDefault()}}).insertAfter(t));var A=".smartmenus_scroll";if(t.dataSM("scroll",{y:this.cssTransforms3d?0:i-m,step:1,itemH:m,subH:h,arrowDownH:this.getHeight(t.dataSM("scroll-arrows").eq(1))}).on(getEventsNS({mouseover:function(e){x.menuScrollOver(t,e)},mouseout:function(e){x.menuScrollOut(t,e)},"mousewheel DOMMouseScroll":function(e){x.menuScrollMousewheel(t,e)}},A)).dataSM("scroll-arrows").css({top:"auto",left:"0",marginLeft:e+(parseInt(t.css("border-left-width"))||0),width:r-(parseInt(t.css("border-left-width"))||0)-(parseInt(t.css("border-right-width"))||0),zIndex:t.css("z-index")}).eq(g&&this.opts.bottomToTopSubMenus?0:1).show(),this.isFixed()){var C={};C[touchEvents?"touchstart touchmove touchend":"pointerdown pointermove pointerup MSPointerDown MSPointerMove MSPointerUp"]=function(e){x.menuScrollTouch(t,e)},t.css({"touch-action":"none","-ms-touch-action":"none"}).on(getEventsNS(C,A))}}}t.css({top:"auto",left:"0",marginLeft:e,marginTop:i-m})},menuScroll:function(t,e,i){var s,o=t.dataSM("scroll"),a=t.dataSM("scroll-arrows"),n=o.up?o.upEnd:o.downEnd;if(!e&&o.momentum){if(o.momentum*=.92,s=o.momentum,.5>s)return this.menuScrollStop(t),void 0}else s=i||(e||!this.opts.scrollAccelerate?this.opts.scrollStep:Math.floor(o.step));var r=t.dataSM("level");if(this.activatedItems[r-1]&&this.activatedItems[r-1].dataSM("sub")&&this.activatedItems[r-1].dataSM("sub").is(":visible")&&this.menuHideSubMenus(r-1),o.y=o.up&&o.y>=n||!o.up&&n>=o.y?o.y:Math.abs(n-o.y)>s?o.y+(o.up?s:-s):n,t.css(this.cssTransforms3d?{"-webkit-transform":"translate3d(0, "+o.y+"px, 0)",transform:"translate3d(0, "+o.y+"px, 0)"}:{marginTop:o.y}),mouse&&(o.up&&o.y>o.downEnd||!o.up&&o.y0;t.dataSM("scroll-arrows").eq(i?0:1).is(":visible")&&(t.dataSM("scroll").up=i,this.menuScroll(t,!0))}e.preventDefault()},menuScrollOut:function(t,e){mouse&&(/^scroll-(up|down)/.test((e.relatedTarget||"").className)||(t[0]==e.relatedTarget||$.contains(t[0],e.relatedTarget))&&this.getClosestMenu(e.relatedTarget)==t[0]||t.dataSM("scroll-arrows").css("visibility","hidden"))},menuScrollOver:function(t,e){if(mouse&&!/^scroll-(up|down)/.test(e.target.className)&&this.getClosestMenu(e.target)==t[0]){this.menuScrollRefreshData(t);var i=t.dataSM("scroll"),s=$(window).scrollTop()-t.dataSM("parent-a").offset().top-i.itemH;t.dataSM("scroll-arrows").eq(0).css("margin-top",s).end().eq(1).css("margin-top",s+this.getViewportHeight()-i.arrowDownH).end().css("visibility","visible")}},menuScrollRefreshData:function(t){var e=t.dataSM("scroll"),i=$(window).scrollTop()-t.dataSM("parent-a").offset().top-e.itemH;this.cssTransforms3d&&(i=-(parseFloat(t.css("margin-top"))-i)),$.extend(e,{upEnd:i,downEnd:i+this.getViewportHeight()-e.subH})},menuScrollStop:function(t){return this.scrollTimeout?(cancelAnimationFrame(this.scrollTimeout),this.scrollTimeout=0,t.dataSM("scroll").step=1,!0):void 0},menuScrollTouch:function(t,e){if(e=e.originalEvent,isTouchEvent(e)){var i=this.getTouchPoint(e);if(this.getClosestMenu(i.target)==t[0]){var s=t.dataSM("scroll");if(/(start|down)$/i.test(e.type))this.menuScrollStop(t)?(e.preventDefault(),this.$touchScrollingSub=t):this.$touchScrollingSub=null,this.menuScrollRefreshData(t),$.extend(s,{touchStartY:i.pageY,touchStartTime:e.timeStamp});else if(/move$/i.test(e.type)){var o=void 0!==s.touchY?s.touchY:s.touchStartY;if(void 0!==o&&o!=i.pageY){this.$touchScrollingSub=t;var a=i.pageY>o;void 0!==s.up&&s.up!=a&&$.extend(s,{touchStartY:i.pageY,touchStartTime:e.timeStamp}),$.extend(s,{up:a,touchY:i.pageY}),this.menuScroll(t,!0,Math.abs(i.pageY-o))}e.preventDefault()}else void 0!==s.touchY&&((s.momentum=15*Math.pow(Math.abs(i.pageY-s.touchStartY)/(e.timeStamp-s.touchStartTime),2))&&(this.menuScrollStop(t),this.menuScroll(t),e.preventDefault()),delete s.touchY)}}},menuShow:function(t){if((t.dataSM("beforefirstshowfired")||(t.dataSM("beforefirstshowfired",!0),this.$root.triggerHandler("beforefirstshow.smapi",t[0])!==!1))&&this.$root.triggerHandler("beforeshow.smapi",t[0])!==!1&&(t.dataSM("shown-before",!0),canAnimate&&t.stop(!0,!0),!t.is(":visible"))){var e=t.dataSM("parent-a"),i=this.isCollapsible();if((this.opts.keepHighlighted||i)&&e.addClass("highlighted"),i)t.removeClass("sm-nowrap").css({zIndex:"",width:"auto",minWidth:"",maxWidth:"",top:"",left:"",marginLeft:"",marginTop:""});else{if(t.css("z-index",this.zIndexInc=(this.zIndexInc||this.getStartZIndex())+1),(this.opts.subMenusMinWidth||this.opts.subMenusMaxWidth)&&(t.css({width:"auto",minWidth:"",maxWidth:""}).addClass("sm-nowrap"),this.opts.subMenusMinWidth&&t.css("min-width",this.opts.subMenusMinWidth),this.opts.subMenusMaxWidth)){var s=this.getWidth(t);t.css("max-width",this.opts.subMenusMaxWidth),s>this.getWidth(t)&&t.removeClass("sm-nowrap").css("width",this.opts.subMenusMaxWidth)}this.menuPosition(t)}var o=function(){t.css("overflow","")};i?canAnimate&&this.opts.collapsibleShowFunction?this.opts.collapsibleShowFunction.call(this,t,o):t.show(this.opts.collapsibleShowDuration,o):canAnimate&&this.opts.showFunction?this.opts.showFunction.call(this,t,o):t.show(this.opts.showDuration,o),e.attr("aria-expanded","true"),t.attr({"aria-expanded":"true","aria-hidden":"false"}),this.visibleSubMenus.push(t),this.$root.triggerHandler("show.smapi",t[0])}},popupHide:function(t){this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0);var e=this;this.hideTimeout=setTimeout(function(){e.menuHideAll()},t?1:this.opts.hideTimeout)},popupShow:function(t,e){if(!this.opts.isPopup)return alert('SmartMenus jQuery Error:\n\nIf you want to show this menu via the "popupShow" method, set the isPopup:true option.'),void 0;if(this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0),this.$root.dataSM("shown-before",!0),canAnimate&&this.$root.stop(!0,!0),!this.$root.is(":visible")){this.$root.css({left:t,top:e});var i=this,s=function(){i.$root.css("overflow","")};canAnimate&&this.opts.showFunction?this.opts.showFunction.call(this,this.$root,s):this.$root.show(this.opts.showDuration,s),this.visibleSubMenus[0]=this.$root}},refresh:function(){this.destroy(!0),this.init(!0)},rootKeyDown:function(t){if(this.handleEvents())switch(t.keyCode){case 27:var e=this.activatedItems[0];if(e){this.menuHideAll(),e[0].focus();var i=e.dataSM("sub");i&&this.menuHide(i)}break;case 32:var s=$(t.target);if(s.is("a")&&this.handleItemEvents(s)){var i=s.dataSM("sub");i&&!i.is(":visible")&&(this.itemClick({currentTarget:t.target}),t.preventDefault())}}},rootOut:function(t){if(this.handleEvents()&&!this.isTouchMode()&&t.target!=this.$root[0]&&(this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0),!this.opts.showOnClick||!this.opts.hideOnClick)){var e=this;this.hideTimeout=setTimeout(function(){e.menuHideAll()},this.opts.hideTimeout)}},rootOver:function(t){this.handleEvents()&&!this.isTouchMode()&&t.target!=this.$root[0]&&this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0)},winResize:function(t){if(this.handleEvents()){if(!("onorientationchange"in window)||"orientationchange"==t.type){var e=this.isCollapsible();this.wasCollapsible&&e||(this.activatedItems.length&&this.activatedItems[this.activatedItems.length-1][0].blur(),this.menuHideAll()),this.wasCollapsible=e}}else if(this.$disableOverlay){var i=this.$root.offset();this.$disableOverlay.css({top:i.top,left:i.left,width:this.$root.outerWidth(),height:this.$root.outerHeight()})}}}}),$.fn.dataSM=function(t,e){return e?this.data(t+"_smartmenus",e):this.data(t+"_smartmenus")},$.fn.removeDataSM=function(t){return this.removeData(t+"_smartmenus")},$.fn.smartmenus=function(options){if("string"==typeof options){var args=arguments,method=options;return Array.prototype.shift.call(args),this.each(function(){var t=$(this).data("smartmenus");t&&t[method]&&t[method].apply(t,args)})}return this.each(function(){var dataOpts=$(this).data("sm-options")||null;if(dataOpts)try{dataOpts=eval("("+dataOpts+")")}catch(e){dataOpts=null,alert('ERROR\n\nSmartMenus jQuery init:\nInvalid "data-sm-options" attribute value syntax.')}new $.SmartMenus(this,$.extend({},$.fn.smartmenus.defaults,options,dataOpts))})},$.fn.smartmenus.defaults={isPopup:!1,mainMenuSubOffsetX:0,mainMenuSubOffsetY:0,subMenusSubOffsetX:0,subMenusSubOffsetY:0,subMenusMinWidth:"10em",subMenusMaxWidth:"20em",subIndicators:!0,subIndicatorsPos:"append",subIndicatorsText:"",scrollStep:30,scrollAccelerate:!0,showTimeout:250,hideTimeout:500,showDuration:0,showFunction:null,hideDuration:0,hideFunction:function(t,e){t.fadeOut(200,e)},collapsibleShowDuration:0,collapsibleShowFunction:function(t,e){t.slideDown(200,e)},collapsibleHideDuration:0,collapsibleHideFunction:function(t,e){t.slideUp(200,e)},showOnClick:!1,hideOnClick:!0,noMouseOver:!1,keepInViewport:!0,keepHighlighted:!0,markCurrentItem:!1,markCurrentTree:!0,rightToLeftSubMenus:!1,bottomToTopSubMenus:!1,collapsibleBehavior:"default"},$}); \ No newline at end of file diff --git a/docs/html/menu.js b/docs/html/menu.js new file mode 100644 index 0000000..54e81cf --- /dev/null +++ b/docs/html/menu.js @@ -0,0 +1,127 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file + */ +function initMenu(relPath,searchEnabled,serverSide,searchPage,search) { + function makeTree(data,relPath) { + var result=''; + if ('children' in data) { + result+=''; + } + return result; + } + var searchBox; + if (searchEnabled) { + if (serverSide) { + searchBox='
'+ + '
'+ + '
'+ + ''+ + '
'+ + '
'+ + '
'+ + '
'; + } else { + searchBox='
'+ + ''+ + ''+ + ''+ + ''+ + ''+ + '' + '' + '
'; + } + } + + $('#main-nav').before('
'+ + ''+ + ''+ + '
'); + $('#main-nav').append(makeTree(menudata,relPath)); + $('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu'); + if (searchBox) { + $('#main-menu').append('
  • '); + } + var $mainMenuState = $('#main-menu-state'); + var prevWidth = 0; + if ($mainMenuState.length) { + function initResizableIfExists() { + if (typeof initResizable==='function') initResizable(); + } + // animate mobile menu + $mainMenuState.change(function(e) { + var $menu = $('#main-menu'); + var options = { duration: 250, step: initResizableIfExists }; + if (this.checked) { + options['complete'] = function() { $menu.css('display', 'block') }; + $menu.hide().slideDown(options); + } else { + options['complete'] = function() { $menu.css('display', 'none') }; + $menu.show().slideUp(options); + } + }); + // set default menu visibility + function resetState() { + var $menu = $('#main-menu'); + var $mainMenuState = $('#main-menu-state'); + var newWidth = $(window).outerWidth(); + if (newWidth!=prevWidth) { + if ($(window).outerWidth()<768) { + $mainMenuState.prop('checked',false); $menu.hide(); + $('#searchBoxPos1').html(searchBox); + $('#searchBoxPos2').hide(); + } else { + $menu.show(); + $('#searchBoxPos1').empty(); + $('#searchBoxPos2').html(searchBox); + $('#searchBoxPos2').show(); + } + prevWidth = newWidth; + } + } + $(window).ready(function() { resetState(); initResizableIfExists(); }); + $(window).resize(resetState); + } + $('#main-menu').smartmenus(); +} +/* @license-end */ diff --git a/docs/html/menudata.js b/docs/html/menudata.js new file mode 100644 index 0000000..ca7eddd --- /dev/null +++ b/docs/html/menudata.js @@ -0,0 +1,101 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file +*/ +var menudata={children:[ +{text:"Main Page",url:"index.html"}, +{text:"Namespaces",url:"namespaces.html",children:[ +{text:"Namespace List",url:"namespaces.html"}, +{text:"Namespace Members",url:"namespacemembers.html",children:[ +{text:"All",url:"namespacemembers.html",children:[ +{text:"b",url:"namespacemembers.html#index_b"}, +{text:"c",url:"namespacemembers.html#index_c"}, +{text:"d",url:"namespacemembers.html#index_d"}, +{text:"f",url:"namespacemembers.html#index_f"}, +{text:"h",url:"namespacemembers.html#index_h"}, +{text:"k",url:"namespacemembers.html#index_k"}, +{text:"o",url:"namespacemembers.html#index_o"}, +{text:"r",url:"namespacemembers.html#index_r"}, +{text:"t",url:"namespacemembers.html#index_t"}, +{text:"v",url:"namespacemembers.html#index_v"}]}, +{text:"Functions",url:"namespacemembers_func.html"}, +{text:"Typedefs",url:"namespacemembers_type.html"}, +{text:"Enumerations",url:"namespacemembers_enum.html"}]}]}, +{text:"Classes",url:"annotated.html",children:[ +{text:"Class List",url:"annotated.html"}, +{text:"Class Index",url:"classes.html"}, +{text:"Class Hierarchy",url:"hierarchy.html"}, +{text:"Class Members",url:"functions.html",children:[ +{text:"All",url:"functions.html",children:[ +{text:"a",url:"functions.html#index_a"}, +{text:"c",url:"functions.html#index_c"}, +{text:"d",url:"functions.html#index_d"}, +{text:"e",url:"functions.html#index_e"}, +{text:"f",url:"functions.html#index_f"}, +{text:"g",url:"functions.html#index_g"}, +{text:"h",url:"functions.html#index_h"}, +{text:"i",url:"functions.html#index_i"}, +{text:"k",url:"functions.html#index_k"}, +{text:"l",url:"functions.html#index_l"}, +{text:"m",url:"functions.html#index_m"}, +{text:"n",url:"functions.html#index_n"}, +{text:"o",url:"functions.html#index_o"}, +{text:"p",url:"functions.html#index_p"}, +{text:"r",url:"functions.html#index_r"}, +{text:"s",url:"functions.html#index_s"}, +{text:"t",url:"functions.html#index_t"}, +{text:"u",url:"functions.html#index_u"}, +{text:"v",url:"functions.html#index_v"}, +{text:"w",url:"functions.html#index_w"}, +{text:"x",url:"functions.html#index_x"}, +{text:"y",url:"functions.html#index_y"}, +{text:"z",url:"functions.html#index_z"}, +{text:"~",url:"functions.html#index__7E"}]}, +{text:"Functions",url:"functions_func.html",children:[ +{text:"c",url:"functions_func.html#index_c"}, +{text:"d",url:"functions_func.html#index_d"}, +{text:"e",url:"functions_func.html#index_e"}, +{text:"f",url:"functions_func.html#index_f"}, +{text:"g",url:"functions_func.html#index_g"}, +{text:"i",url:"functions_func.html#index_i"}, +{text:"k",url:"functions_func.html#index_k"}, +{text:"l",url:"functions_func.html#index_l"}, +{text:"m",url:"functions_func.html#index_m"}, +{text:"n",url:"functions_func.html#index_n"}, +{text:"o",url:"functions_func.html#index_o"}, +{text:"p",url:"functions_func.html#index_p"}, +{text:"r",url:"functions_func.html#index_r"}, +{text:"s",url:"functions_func.html#index_s"}, +{text:"u",url:"functions_func.html#index_u"}, +{text:"v",url:"functions_func.html#index_v"}, +{text:"w",url:"functions_func.html#index_w"}, +{text:"~",url:"functions_func.html#index__7E"}]}, +{text:"Variables",url:"functions_vars.html"}, +{text:"Typedefs",url:"functions_type.html"}, +{text:"Related Functions",url:"functions_rela.html"}]}]}, +{text:"Files",url:"files.html",children:[ +{text:"File List",url:"files.html"}, +{text:"File Members",url:"globals.html",children:[ +{text:"All",url:"globals.html"}, +{text:"Functions",url:"globals_func.html"}, +{text:"Macros",url:"globals_defs.html"}]}]}]} diff --git a/docs/html/namespacemembers.html b/docs/html/namespacemembers.html new file mode 100644 index 0000000..ab998bf --- /dev/null +++ b/docs/html/namespacemembers.html @@ -0,0 +1,112 @@ + + + + + + + +Vulk: Namespace Members + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + +
    +
    +
    Here is a list of all namespace members with links to the namespace documentation for each member:
    + +

    - b -

      +
    • Buttons : vulk
      • +
    + + +

    - c -

    + + +

    - d -

      +
    • Duration : vulk
      • +
    + + +

    - f -

    + + +

    - h -

      +
    • handleVulkanError() : vulk
      • +
    + + +

    - k -

    + + +

    - o -

      +
    • operator*() : vulk
      • +
    • operator+() : vulk
      • +
    • operator-() : vulk
      • +
    • operator/() : vulk
      • +
    + + +

    - r -

    + + +

    - t -

      +
    • TimePoint : vulk
      • +
    + + +

    - v -

    +
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/namespacemembers_enum.html b/docs/html/namespacemembers_enum.html new file mode 100644 index 0000000..c8a1fbc --- /dev/null +++ b/docs/html/namespacemembers_enum.html @@ -0,0 +1,52 @@ + + + + + + + +Vulk: Namespace Members + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + +
    +
    +  +
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/namespacemembers_func.html b/docs/html/namespacemembers_func.html new file mode 100644 index 0000000..cfb8780 --- /dev/null +++ b/docs/html/namespacemembers_func.html @@ -0,0 +1,57 @@ + + + + + + + +Vulk: Namespace Members + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + +
    +
    +  +
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/namespacemembers_type.html b/docs/html/namespacemembers_type.html new file mode 100644 index 0000000..19aa09c --- /dev/null +++ b/docs/html/namespacemembers_type.html @@ -0,0 +1,65 @@ + + + + + + + +Vulk: Namespace Members + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + +
    +
    +  +
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/namespaces.html b/docs/html/namespaces.html new file mode 100644 index 0000000..a177c0c --- /dev/null +++ b/docs/html/namespaces.html @@ -0,0 +1,72 @@ + + + + + + + +Vulk: Namespace List + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + +
    +
    +
    Namespace List
    +
    +
    +
    Here is a list of all namespaces with brief descriptions:
    +
    [detail level 123]
    + + + + + + + + + + + + + + + + + +
     ▼Nvulk
     ▼Nutils
     CScopedProfiler
     CContextGLFW
     CContextVulkan
     CException
     CFrameManager
     CGLFWException
     CKeyboard
     CMat3
     CMouse
     CRect
     CShader
     CVec2
     CVec3
     CVulkanException
     CWindow
    +
    +
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/namespacevulk.html b/docs/html/namespacevulk.html new file mode 100644 index 0000000..687724a --- /dev/null +++ b/docs/html/namespacevulk.html @@ -0,0 +1,1310 @@ + + + + + + + +Vulk: vulk Namespace Reference + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + +
    +
    +
    +Namespaces | +Classes | +Typedefs | +Enumerations | +Functions
    +
    vulk Namespace Reference
    +
    +
    + + + + +

    +Namespaces

    namespace  utils
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Classes

    class  ContextGLFW
     
    class  ContextVulkan
     
    class  Exception
     
    class  FrameManager
     
    class  GLFWException
     
    class  Keyboard
     
    struct  Mat3
     
    class  Mouse
     
    struct  Rect
     
    class  Shader
     
    struct  Vec2
     
    struct  Vec3
     
    class  VulkanException
     
    class  Window
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Typedefs

    using Rectf = Rect< float >
     
    using Rectd = Rect< double >
     
    using Recti = Rect< int >
     
    using Rectu = Rect< unsigned int >
     
    using Clock = std::chrono::high_resolution_clock
     
    using Duration = std::chrono::duration< float >
     
    using TimePoint = decltype(Clock::now())
     
    using Vec2f = Vec2< float >
     
    using Vec2d = Vec2< double >
     
    using Vec2i = Vec2< int >
     
    using Vec2u = Vec2< unsigned int >
     
    using Vec3f = Vec3< float >
     
    using Vec3d = Vec3< double >
     
    using Vec3i = Vec3< int >
     
    using Vec3u = Vec3< unsigned int >
     
    + + + + + +

    +Enumerations

    enum class  Key {
    +  UNKNOWN = GLFW_KEY_UNKNOWN +, SPACE = GLFW_KEY_SPACE +, APOSTROPHE = GLFW_KEY_APOSTROPHE +, COMMA = GLFW_KEY_COMMA +,
    +  MINUS = GLFW_KEY_MINUS +, PERIOD = GLFW_KEY_PERIOD +, SLASH = GLFW_KEY_SLASH +, NUM_0 = GLFW_KEY_0 +,
    +  NUM_1 = GLFW_KEY_1 +, NUM_2 = GLFW_KEY_2 +, NUM_3 = GLFW_KEY_3 +, NUM_4 = GLFW_KEY_4 +,
    +  NUM_5 = GLFW_KEY_5 +, NUM_6 = GLFW_KEY_6 +, NUM_7 = GLFW_KEY_7 +, NUM_8 = GLFW_KEY_8 +,
    +  NUM_9 = GLFW_KEY_9 +, SEMICOLON = GLFW_KEY_SEMICOLON +, EQUAL = GLFW_KEY_EQUAL +, A = GLFW_KEY_A +,
    +  B = GLFW_KEY_B +, C = GLFW_KEY_C +, D = GLFW_KEY_D +, E = GLFW_KEY_E +,
    +  F = GLFW_KEY_F +, G = GLFW_KEY_G +, H = GLFW_KEY_H +, I = GLFW_KEY_I +,
    +  J = GLFW_KEY_J +, K = GLFW_KEY_K +, L = GLFW_KEY_L +, M = GLFW_KEY_M +,
    +  N = GLFW_KEY_N +, O = GLFW_KEY_O +, P = GLFW_KEY_P +, Q = GLFW_KEY_Q +,
    +  R = GLFW_KEY_R +, S = GLFW_KEY_S +, T = GLFW_KEY_T +, U = GLFW_KEY_U +,
    +  V = GLFW_KEY_V +, W = GLFW_KEY_W +, X = GLFW_KEY_X +, Y = GLFW_KEY_Y +,
    +  Z = GLFW_KEY_Z +, LEFT_BRACKET = GLFW_KEY_LEFT_BRACKET +, BACKSLASH = GLFW_KEY_BACKSLASH +, RIGHT_BRACKET = GLFW_KEY_RIGHT_BRACKET +,
    +  GRAVE_ACCENT = GLFW_KEY_GRAVE_ACCENT +, WORLD_1 = GLFW_KEY_WORLD_1 +, WORLD_2 = GLFW_KEY_WORLD_2 +, ESCAPE = GLFW_KEY_ESCAPE +,
    +  ENTER = GLFW_KEY_ENTER +, TAB = GLFW_KEY_TAB +, BACKSPACE = GLFW_KEY_BACKSPACE +, INSERT = GLFW_KEY_INSERT +,
    +  KEY_DELETE = GLFW_KEY_DELETE +, RIGHT = GLFW_KEY_RIGHT +, LEFT = GLFW_KEY_LEFT +, DOWN = GLFW_KEY_DOWN +,
    +  UP = GLFW_KEY_UP +, PAGE_UP = GLFW_KEY_PAGE_UP +, PAGE_DOWN = GLFW_KEY_PAGE_DOWN +, HOME = GLFW_KEY_HOME +,
    +  END = GLFW_KEY_END +, CAPS_LOCK = GLFW_KEY_CAPS_LOCK +, SCROLL_LOCK = GLFW_KEY_SCROLL_LOCK +, NUM_LOCK = GLFW_KEY_NUM_LOCK +,
    +  PRINT_SCREEN = GLFW_KEY_PRINT_SCREEN +, PAUSE = GLFW_KEY_PAUSE +, F1 = GLFW_KEY_F1 +, F2 = GLFW_KEY_F2 +,
    +  F3 = GLFW_KEY_F3 +, F4 = GLFW_KEY_F4 +, F5 = GLFW_KEY_F5 +, F6 = GLFW_KEY_F6 +,
    +  F7 = GLFW_KEY_F7 +, F8 = GLFW_KEY_F8 +, F9 = GLFW_KEY_F9 +, F10 = GLFW_KEY_F10 +,
    +  F11 = GLFW_KEY_F11 +, F12 = GLFW_KEY_F12 +, F13 = GLFW_KEY_F13 +, F14 = GLFW_KEY_F14 +,
    +  F15 = GLFW_KEY_F15 +, F16 = GLFW_KEY_F16 +, F17 = GLFW_KEY_F17 +, F18 = GLFW_KEY_F18 +,
    +  F19 = GLFW_KEY_F19 +, F20 = GLFW_KEY_F20 +, F21 = GLFW_KEY_F21 +, F22 = GLFW_KEY_F22 +,
    +  F23 = GLFW_KEY_F23 +, F24 = GLFW_KEY_F24 +, F25 = GLFW_KEY_F25 +, KP_0 = GLFW_KEY_KP_0 +,
    +  KP_1 = GLFW_KEY_KP_1 +, KP_2 = GLFW_KEY_KP_2 +, KP_3 = GLFW_KEY_KP_3 +, KP_4 = GLFW_KEY_KP_4 +,
    +  KP_5 = GLFW_KEY_KP_5 +, KP_6 = GLFW_KEY_KP_6 +, KP_7 = GLFW_KEY_KP_7 +, KP_8 = GLFW_KEY_KP_8 +,
    +  KP_9 = GLFW_KEY_KP_9 +, KP_DECIMAL = GLFW_KEY_KP_DECIMAL +, KP_DIVIDE = GLFW_KEY_KP_DIVIDE +, KP_MULTIPLY = GLFW_KEY_KP_MULTIPLY +,
    +  KP_SUBTRACT = GLFW_KEY_KP_SUBTRACT +, KP_ADD = GLFW_KEY_KP_ADD +, KP_ENTER = GLFW_KEY_KP_ENTER +, KP_EQUAL = GLFW_KEY_KP_EQUAL +,
    +  LEFT_SHIFT = GLFW_KEY_LEFT_SHIFT +, LEFT_CONTROL = GLFW_KEY_LEFT_CONTROL +, LEFT_ALT = GLFW_KEY_LEFT_ALT +, LEFT_SUPER = GLFW_KEY_LEFT_SUPER +,
    +  RIGHT_SHIFT = GLFW_KEY_RIGHT_SHIFT +, RIGHT_CONTROL = GLFW_KEY_RIGHT_CONTROL +, RIGHT_ALT = GLFW_KEY_RIGHT_ALT +, RIGHT_SUPER = GLFW_KEY_RIGHT_SUPER +,
    +  MENU = GLFW_KEY_MENU +
    + }
     
    enum class  Buttons {
    +  BUTTON_1 = GLFW_MOUSE_BUTTON_1 +, BUTTON_2 = GLFW_MOUSE_BUTTON_2 +, BUTTON_3 = GLFW_MOUSE_BUTTON_3 +, BUTTON_4 = GLFW_MOUSE_BUTTON_4 +,
    +  BUTTON_5 = GLFW_MOUSE_BUTTON_5 +, BUTTON_6 = GLFW_MOUSE_BUTTON_6 +, BUTTON_7 = GLFW_MOUSE_BUTTON_7 +, BUTTON_8 = GLFW_MOUSE_BUTTON_8 +,
    +  BUTTON_LEFT = GLFW_MOUSE_BUTTON_LEFT +, BUTTON_RIGHT = GLFW_MOUSE_BUTTON_RIGHT +, BUTTON_MIDDLE = GLFW_MOUSE_BUTTON_MIDDLE +, BUTTON_LAST = GLFW_MOUSE_BUTTON_LAST +
    + }
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Functions

    vk::Result handleVulkanError (vk::Result res)
     
    vk::Result handleVulkanError (VkResult vkRes)
     
    template<typename T >
    T & handleVulkanError (vk::ResultValue< T > &res)
     
    template<typename T >
    const T & handleVulkanError (const vk::ResultValue< T > &res)
     
    template<typename T >
    constexpr Vec2< T > operator+ (const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
     
    template<typename T >
    constexpr Vec2< T > operator- (const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
     
    template<typename T >
    constexpr Vec2< T > operator* (const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
     
    template<typename T >
    constexpr Vec2< T > operator* (const Vec2< T > &lhs, T t) noexcept
     
    template<typename T >
    constexpr Vec2< T > operator* (T t, const Vec2< T > &rhs) noexcept
     
    template<typename T >
    constexpr Vec2< T > operator/ (const Vec2< T > &lhs, T t) noexcept
     
    template<typename T >
    constexpr Vec3< T > operator+ (const Vec3< T > &lhs, const Vec3< T > &rhs) noexcept
     
    template<typename T >
    constexpr Vec3< T > operator- (const Vec3< T > &lhs, const Vec3< T > &rhs) noexcept
     
    template<typename T >
    constexpr Vec3< T > operator* (const Vec3< T > &lhs, const Vec3< T > &rhs) noexcept
     
    template<typename T >
    constexpr Vec3< T > operator* (const Vec3< T > &lhs, T t) noexcept
     
    template<typename T >
    constexpr Vec3< T > operator* (T t, const Vec3< T > &rhs) noexcept
     
    template<typename T >
    constexpr Vec3< T > operator/ (const Vec3< T > &lhs, T t) noexcept
     
    +

    Typedef Documentation

    + +

    ◆ Clock

    + +
    +
    + + + + +
    using vulk::Clock = typedef std::chrono::high_resolution_clock
    +
    + +
    +
    + +

    ◆ Duration

    + +
    +
    + + + + +
    using vulk::Duration = typedef std::chrono::duration<float>
    +
    + +
    +
    + +

    ◆ Rectd

    + +
    +
    + + + + +
    using vulk::Rectd = typedef Rect<double>
    +
    + +
    +
    + +

    ◆ Rectf

    + +
    +
    + + + + +
    using vulk::Rectf = typedef Rect<float>
    +
    + +
    +
    + +

    ◆ Recti

    + +
    +
    + + + + +
    using vulk::Recti = typedef Rect<int>
    +
    + +
    +
    + +

    ◆ Rectu

    + +
    +
    + + + + +
    using vulk::Rectu = typedef Rect<unsigned int>
    +
    + +
    +
    + +

    ◆ TimePoint

    + +
    +
    + + + + +
    using vulk::TimePoint = typedef decltype(Clock::now())
    +
    + +
    +
    + +

    ◆ Vec2d

    + +
    +
    + + + + +
    using vulk::Vec2d = typedef Vec2<double>
    +
    + +
    +
    + +

    ◆ Vec2f

    + +
    +
    + + + + +
    using vulk::Vec2f = typedef Vec2<float>
    +
    + +
    +
    + +

    ◆ Vec2i

    + +
    +
    + + + + +
    using vulk::Vec2i = typedef Vec2<int>
    +
    + +
    +
    + +

    ◆ Vec2u

    + +
    +
    + + + + +
    using vulk::Vec2u = typedef Vec2<unsigned int>
    +
    + +
    +
    + +

    ◆ Vec3d

    + +
    +
    + + + + +
    using vulk::Vec3d = typedef Vec3<double>
    +
    + +
    +
    + +

    ◆ Vec3f

    + +
    +
    + + + + +
    using vulk::Vec3f = typedef Vec3<float>
    +
    + +
    +
    + +

    ◆ Vec3i

    + +
    +
    + + + + +
    using vulk::Vec3i = typedef Vec3<int>
    +
    + +
    +
    + +

    ◆ Vec3u

    + +
    +
    + + + + +
    using vulk::Vec3u = typedef Vec3<unsigned int>
    +
    + +
    +
    +

    Enumeration Type Documentation

    + +

    ◆ Buttons

    + +
    +
    + + + + + +
    + + + + +
    enum class vulk::Buttons
    +     		+strong
    +
    + + + + + + + + + + + + + +
    Enumerator
    BUTTON_1 
    BUTTON_2 
    BUTTON_3 
    BUTTON_4 
    BUTTON_5 
    BUTTON_6 
    BUTTON_7 
    BUTTON_8 
    BUTTON_LEFT 
    BUTTON_RIGHT 
    BUTTON_MIDDLE 
    BUTTON_LAST 
    + +
    +
    + +

    ◆ Key

    + +
    +
    + + + + + +
    + + + + +
    enum class vulk::Key
    +     		+strong
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Enumerator
    UNKNOWN 
    SPACE 
    APOSTROPHE 
    COMMA 
    MINUS 
    PERIOD 
    SLASH 
    NUM_0 
    NUM_1 
    NUM_2 
    NUM_3 
    NUM_4 
    NUM_5 
    NUM_6 
    NUM_7 
    NUM_8 
    NUM_9 
    SEMICOLON 
    EQUAL 
    A 
    B 
    C 
    D 
    E 
    F 
    G 
    H 
    I 
    J 
    K 
    L 
    M 
    N 
    O 
    P 
    Q 
    R 
    S 
    T 
    U 
    V 
    W 
    X 
    Y 
    Z 
    LEFT_BRACKET 
    BACKSLASH 
    RIGHT_BRACKET 
    GRAVE_ACCENT 
    WORLD_1 
    WORLD_2 
    ESCAPE 
    ENTER 
    TAB 
    BACKSPACE 
    INSERT 
    KEY_DELETE 
    RIGHT 
    LEFT 
    DOWN 
    UP 
    PAGE_UP 
    PAGE_DOWN 
    HOME 
    END 
    CAPS_LOCK 
    SCROLL_LOCK 
    NUM_LOCK 
    PRINT_SCREEN 
    PAUSE 
    F1 
    F2 
    F3 
    F4 
    F5 
    F6 
    F7 
    F8 
    F9 
    F10 
    F11 
    F12 
    F13 
    F14 
    F15 
    F16 
    F17 
    F18 
    F19 
    F20 
    F21 
    F22 
    F23 
    F24 
    F25 
    KP_0 
    KP_1 
    KP_2 
    KP_3 
    KP_4 
    KP_5 
    KP_6 
    KP_7 
    KP_8 
    KP_9 
    KP_DECIMAL 
    KP_DIVIDE 
    KP_MULTIPLY 
    KP_SUBTRACT 
    KP_ADD 
    KP_ENTER 
    KP_EQUAL 
    LEFT_SHIFT 
    LEFT_CONTROL 
    LEFT_ALT 
    LEFT_SUPER 
    RIGHT_SHIFT 
    RIGHT_CONTROL 
    RIGHT_ALT 
    RIGHT_SUPER 
    MENU 
    + +
    +
    +

    Function Documentation

    + +

    ◆ handleVulkanError() [1/4]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    const T & vulk::handleVulkanError (const vk::ResultValue< T > & res)
    +     		+inline
    +
    + +
    +
    + +

    ◆ handleVulkanError() [2/4]

    + +
    +
    + + + + + +
    + + + + + + + + +
    vk::Result vulk::handleVulkanError (vk::Result res)
    +     		+inline
    +
    + +
    +
    + +

    ◆ handleVulkanError() [3/4]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    T & vulk::handleVulkanError (vk::ResultValue< T > & res)
    +     		+inline
    +
    + +
    +
    + +

    ◆ handleVulkanError() [4/4]

    + +
    +
    + + + + + +
    + + + + + + + + +
    vk::Result vulk::handleVulkanError (VkResult vkRes)
    +     		+inline
    +
    + +
    +
    + +

    ◆ operator*() [1/6]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr Vec2< T > vulk::operator* (const Vec2< T > & lhs,
    const Vec2< T > & rhs 
    )
    +     		+constexprnoexcept
    +
    + +
    +
    + +

    ◆ operator*() [2/6]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr Vec2< T > vulk::operator* (const Vec2< T > & lhs,
    T t 
    )
    +     		+constexprnoexcept
    +
    + +
    +
    + +

    ◆ operator*() [3/6]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr Vec3< T > vulk::operator* (const Vec3< T > & lhs,
    const Vec3< T > & rhs 
    )
    +     		+constexprnoexcept
    +
    + +
    +
    + +

    ◆ operator*() [4/6]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr Vec3< T > vulk::operator* (const Vec3< T > & lhs,
    T t 
    )
    +     		+constexprnoexcept
    +
    + +
    +
    + +

    ◆ operator*() [5/6]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr Vec2< T > vulk::operator* (T t,
    const Vec2< T > & rhs 
    )
    +     		+constexprnoexcept
    +
    + +
    +
    + +

    ◆ operator*() [6/6]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr Vec3< T > vulk::operator* (T t,
    const Vec3< T > & rhs 
    )
    +     		+constexprnoexcept
    +
    + +
    +
    + +

    ◆ operator+() [1/2]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr Vec2< T > vulk::operator+ (const Vec2< T > & lhs,
    const Vec2< T > & rhs 
    )
    +     		+constexprnoexcept
    +
    + +
    +
    + +

    ◆ operator+() [2/2]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr Vec3< T > vulk::operator+ (const Vec3< T > & lhs,
    const Vec3< T > & rhs 
    )
    +     		+constexprnoexcept
    +
    + +
    +
    + +

    ◆ operator-() [1/2]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr Vec2< T > vulk::operator- (const Vec2< T > & lhs,
    const Vec2< T > & rhs 
    )
    +     		+constexprnoexcept
    +
    + +
    +
    + +

    ◆ operator-() [2/2]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr Vec3< T > vulk::operator- (const Vec3< T > & lhs,
    const Vec3< T > & rhs 
    )
    +     		+constexprnoexcept
    +
    + +
    +
    + +

    ◆ operator/() [1/2]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr Vec2< T > vulk::operator/ (const Vec2< T > & lhs,
    T t 
    )
    +     		+constexprnoexcept
    +
    + +
    +
    + +

    ◆ operator/() [2/2]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr Vec3< T > vulk::operator/ (const Vec3< T > & lhs,
    T t 
    )
    +     		+constexprnoexcept
    +
    + +
    +
    +
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/namespacevulk_1_1utils.html b/docs/html/namespacevulk_1_1utils.html new file mode 100644 index 0000000..1243b38 --- /dev/null +++ b/docs/html/namespacevulk_1_1utils.html @@ -0,0 +1,121 @@ + + + + + + + +Vulk: vulk::utils Namespace Reference + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + + +
    +
    +
    +Classes | +Functions
    +
    vulk::utils Namespace Reference
    +
    +
    + + + + +

    +Classes

    class  ScopedProfiler
     
    + + + + + + +

    +Functions

    template<typename T , typename Allocator >
    bool vectorContains (const std::vector< T, Allocator > &vector, const T &element)
     
    std::vector< char > fileToBinary (const char *filePath)
     
    +

    Function Documentation

    + +

    ◆ fileToBinary()

    + +
    +
    + + + + + + + + +
    std::vector< char > vulk::utils::fileToBinary (const char * filePath)
    +
    + +
    +
    + +

    ◆ vectorContains()

    + +
    +
    +
    +template<typename T , typename Allocator >
    + + + + + + + + + + + + + + + + + + +
    bool vulk::utils::vectorContains (const std::vector< T, Allocator > & vector,
    const T & element 
    )
    +
    + +
    +
    +
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/nav_f.png b/docs/html/nav_f.png new file mode 100644 index 0000000000000000000000000000000000000000..72a58a529ed3a9ed6aa0c51a79cf207e026deee2 GIT binary patch literal 153 zcmeAS@N?(olHy`uVBq!ia0vp^j6iI`!2~2XGqLUlQVE_ejv*C{Z|{2ZH7M}7UYxc) zn!W8uqtnIQ>_z8U literal 0 HcmV?d00001 diff --git a/docs/html/nav_g.png b/docs/html/nav_g.png new file mode 100644 index 0000000000000000000000000000000000000000..2093a237a94f6c83e19ec6e5fd42f7ddabdafa81 GIT binary patch literal 95 zcmeAS@N?(olHy`uVBq!ia0vp^j6lrB!3HFm1ilyoDK$?Q$B+ufw|5PB85lU25BhtE tr?otc=hd~V+ws&_A@j8Fiv!KF$B+ufw|5=67#uj90@pIL wZ=Q8~_Ju`#59=RjDrmm`tMD@M=!-l18IR?&vFVdQ&MBb@0HFXL1|%O$WD@{VPM$7~Ar*{o?;hlAFyLXmaDC0y znK1_#cQqJWPES%4Uujug^TE?jMft$}Eq^WaR~)%f)vSNs&gek&x%A9X9sM-{AmhX=Jf(#6djGiuzAr*{o?=JLmPLyc> z_*`QK&+BH@jWrYJ7>r6%keRM@)Qyv8R=enp0jiI>aWlGyB58O zFVR20d+y`K7vDw(hJF3;>dD*3-?v=<8M)@x|EEGLnJsniYK!2U1 Y!`|5biEc?d1`HDhPgg&ebxsLQ02F6;9RL6T literal 0 HcmV?d00001 diff --git a/docs/html/struct_uniform_buffer_object-members.html b/docs/html/struct_uniform_buffer_object-members.html new file mode 100644 index 0000000..45694cc --- /dev/null +++ b/docs/html/struct_uniform_buffer_object-members.html @@ -0,0 +1,57 @@ + + + + + + + +Vulk: Member List + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + +
    +
    +
    UniformBufferObject Member List
    +
    +
    + +

    This is the complete list of members for UniformBufferObject, including all inherited members.

    + + + + +
    modelUniformBufferObject
    projectionUniformBufferObject
    viewUniformBufferObject
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/struct_uniform_buffer_object.html b/docs/html/struct_uniform_buffer_object.html new file mode 100644 index 0000000..22f234c --- /dev/null +++ b/docs/html/struct_uniform_buffer_object.html @@ -0,0 +1,112 @@ + + + + + + + +Vulk: UniformBufferObject Struct Reference + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + +
    +
    +
    +Public Attributes | +List of all members
    +
    UniformBufferObject Struct Reference
    +
    +
    + +

    #include <Objects.hpp>

    + + + + + + + + +

    +Public Attributes

    glm::mat4 model {}
     
    glm::mat4 view {}
     
    glm::mat4 projection {}
     
    +

    Member Data Documentation

    + +

    ◆ model

    + +
    +
    + + + + +
    glm::mat4 UniformBufferObject::model {}
    +
    + +
    +
    + +

    ◆ projection

    + +
    +
    + + + + +
    glm::mat4 UniformBufferObject::projection {}
    +
    + +
    +
    + +

    ◆ view

    + +
    +
    + + + + +
    glm::mat4 UniformBufferObject::view {}
    +
    + +
    +
    +
    The documentation for this struct was generated from the following file: +
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/struct_vertex-members.html b/docs/html/struct_vertex-members.html new file mode 100644 index 0000000..3edc684 --- /dev/null +++ b/docs/html/struct_vertex-members.html @@ -0,0 +1,59 @@ + + + + + + + +Vulk: Member List + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + +
    +
    +
    Vertex Member List
    +
    +
    + +

    This is the complete list of members for Vertex, including all inherited members.

    + + + + + + +
    AttributeDescriptions typedefVertex
    colorVertex
    getAttributeDescriptions() noexceptVertexstatic
    getBindingDescription() noexceptVertexstatic
    positionVertex
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/struct_vertex.html b/docs/html/struct_vertex.html new file mode 100644 index 0000000..c74ba91 --- /dev/null +++ b/docs/html/struct_vertex.html @@ -0,0 +1,176 @@ + + + + + + + +Vulk: Vertex Struct Reference + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + +
    +
    +
    +Public Types | +Static Public Member Functions | +Public Attributes | +List of all members
    +
    Vertex Struct Reference
    +
    +
    + +

    #include <Objects.hpp>

    + + + + +

    +Public Types

    using AttributeDescriptions = std::array< vk::VertexInputAttributeDescription, 2 >
     
    + + + + + +

    +Static Public Member Functions

    static vk::VertexInputBindingDescription getBindingDescription () noexcept
     
    static AttributeDescriptions getAttributeDescriptions () noexcept
     
    + + + + + +

    +Public Attributes

    glm::vec2 position {}
     
    glm::vec3 color {}
     
    +

    Member Typedef Documentation

    + +

    ◆ AttributeDescriptions

    + +
    +
    + + + + +
    using Vertex::AttributeDescriptions = std::array<vk::VertexInputAttributeDescription, 2>
    +
    + +
    +
    +

    Member Function Documentation

    + +

    ◆ getAttributeDescriptions()

    + +
    +
    + + + + + +
    + + + + + + + +
    static AttributeDescriptions Vertex::getAttributeDescriptions ()
    +     		+staticnoexcept
    +
    + +
    +
    + +

    ◆ getBindingDescription()

    + +
    +
    + + + + + +
    + + + + + + + +
    static vk::VertexInputBindingDescription Vertex::getBindingDescription ()
    +     		+staticnoexcept
    +
    + +
    +
    +

    Member Data Documentation

    + +

    ◆ color

    + +
    +
    + + + + +
    glm::vec3 Vertex::color {}
    +
    + +
    +
    + +

    ◆ position

    + +
    +
    + + + + +
    glm::vec2 Vertex::position {}
    +
    + +
    +
    +
    The documentation for this struct was generated from the following file: +
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/structvulk_1_1_mat3-members.html b/docs/html/structvulk_1_1_mat3-members.html new file mode 100644 index 0000000..6f5ed82 --- /dev/null +++ b/docs/html/structvulk_1_1_mat3-members.html @@ -0,0 +1,67 @@ + + + + + + + +Vulk: Member List + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + + +
    +
    +
    vulk::Mat3< T > Member List
    +
    +
    + +

    This is the complete list of members for vulk::Mat3< T >, including all inherited members.

    + + + + + + + + + + +
    coFactor() const noexceptvulk::Mat3< T >inline
    determinant() const noexceptvulk::Mat3< T >inline
    inverse() const noexceptvulk::Mat3< T >inline
    mvulk::Mat3< T >
    Mat3()=defaultvulk::Mat3< T >
    Mat3(T value)vulk::Mat3< T >inlineexplicit
    Mat3(const std::array< T, 9 > mat)vulk::Mat3< T >inlineexplicit
    Mat3(T a1, T a2, T a3, T a4, T a5, T a6, T a7, T a8, T a9)vulk::Mat3< T >inline
    operator<<vulk::Mat3< T >friend
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/structvulk_1_1_mat3.html b/docs/html/structvulk_1_1_mat3.html new file mode 100644 index 0000000..b99e241 --- /dev/null +++ b/docs/html/structvulk_1_1_mat3.html @@ -0,0 +1,400 @@ + + + + + + + +Vulk: vulk::Mat3< T > Struct Template Reference + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + + +
    +
    +
    +Public Member Functions | +Public Attributes | +Friends | +List of all members
    +
    vulk::Mat3< T > Struct Template Reference
    +
    +
    + +

    #include <Mat3.hpp>

    + + + + + + + + + + + + + + + + +

    +Public Member Functions

    constexpr Mat3 ()=default
     
    constexpr Mat3 (T value)
     
    constexpr Mat3 (const std::array< T, 9 > mat)
     
    constexpr Mat3 (T a1, T a2, T a3, T a4, T a5, T a6, T a7, T a8, T a9)
     
    constexpr Mat3 inverse () const noexcept
     
    constexpr Mat3 coFactor () const noexcept
     
    constexpr T determinant () const noexcept
     
    + + + +

    +Public Attributes

    std::array< T, 9 > m
     
    + + + +

    +Friends

    constexpr friend std::ostream & operator<< (std::ostream &os, const Mat3 &mat3) noexcept
     
    +

    Constructor & Destructor Documentation

    + +

    ◆ Mat3() [1/4]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + +
    constexpr vulk::Mat3< T >::Mat3 ()
    +     		+constexprdefault
    +
    + +
    +
    + +

    ◆ Mat3() [2/4]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    constexpr vulk::Mat3< T >::Mat3 (T value)
    +     		+inlineexplicitconstexpr
    +
    + +
    +
    + +

    ◆ Mat3() [3/4]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    constexpr vulk::Mat3< T >::Mat3 (const std::array< T, 9 > mat)
    +     		+inlineexplicitconstexpr
    +
    + +
    +
    + +

    ◆ Mat3() [4/4]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    constexpr vulk::Mat3< T >::Mat3 (T a1,
    T a2,
    T a3,
    T a4,
    T a5,
    T a6,
    T a7,
    T a8,
    T a9 
    )
    +     		+inlineconstexpr
    +
    + +
    +
    +

    Member Function Documentation

    + +

    ◆ coFactor()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + +
    constexpr Mat3 vulk::Mat3< T >::coFactor () const
    +     		+inlineconstexprnoexcept
    +
    + +
    +
    + +

    ◆ determinant()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + +
    constexpr T vulk::Mat3< T >::determinant () const
    +     		+inlineconstexprnoexcept
    +
    + +
    +
    + +

    ◆ inverse()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + +
    constexpr Mat3 vulk::Mat3< T >::inverse () const
    +     		+inlineconstexprnoexcept
    +
    + +
    +
    +

    Friends And Related Function Documentation

    + +

    ◆ operator<<

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr friend std::ostream & operator<< (std::ostream & os,
    const Mat3< T > & mat3 
    )
    +     		+friend
    +
    + +
    +
    +

    Member Data Documentation

    + +

    ◆ m

    + +
    +
    +
    +template<typename T >
    + + + + +
    std::array<T, 9> vulk::Mat3< T >::m
    +
    +Initial value:
    {
    +
    1.0, 0.0, 0.0,
    +
    0.0, 1.0, 0.0,
    +
    0.0, 0.0, 1.0
    +
    }
    +
    +
    +
    +
    The documentation for this struct was generated from the following file: +
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/structvulk_1_1_rect-members.html b/docs/html/structvulk_1_1_rect-members.html new file mode 100644 index 0000000..df0583f --- /dev/null +++ b/docs/html/structvulk_1_1_rect-members.html @@ -0,0 +1,70 @@ + + + + + + + +Vulk: Member List + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + + +
    +
    +
    vulk::Rect< T > Member List
    +
    +
    + +

    This is the complete list of members for vulk::Rect< T >, including all inherited members.

    + + + + + + + + + + + + + +
    contains(T x, T y) const noexceptvulk::Rect< T >inline
    contains(const Vec2< T > &point) const noexceptvulk::Rect< T >inline
    heightvulk::Rect< T >
    leftvulk::Rect< T >
    operator!=(const Rect< T > &right) const noexceptvulk::Rect< T >inline
    operator<<vulk::Rect< T >friend
    operator==(const Rect< T > &right) const noexceptvulk::Rect< T >inline
    Rect()=defaultvulk::Rect< T >
    Rect(T aLeft, T aTop, T aWidth, T aHeight)vulk::Rect< T >inline
    Rect(const Vec2< T > &pos, const Vec2< T > &size)vulk::Rect< T >inline
    topvulk::Rect< T >
    widthvulk::Rect< T >
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/structvulk_1_1_rect.html b/docs/html/structvulk_1_1_rect.html new file mode 100644 index 0000000..ed620c4 --- /dev/null +++ b/docs/html/structvulk_1_1_rect.html @@ -0,0 +1,442 @@ + + + + + + + +Vulk: vulk::Rect< T > Struct Template Reference + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + + +
    +
    +
    +Public Member Functions | +Public Attributes | +Friends | +List of all members
    +
    vulk::Rect< T > Struct Template Reference
    +
    +
    + +

    #include <Rect.hpp>

    + + + + + + + + + + + + + + + + +

    +Public Member Functions

    constexpr Rect ()=default
     
    constexpr Rect (T aLeft, T aTop, T aWidth, T aHeight)
     
    constexpr Rect (const Vec2< T > &pos, const Vec2< T > &size)
     
    constexpr bool operator== (const Rect< T > &right) const noexcept
     
    constexpr bool operator!= (const Rect< T > &right) const noexcept
     
    constexpr bool contains (T x, T y) const noexcept
     
    constexpr bool contains (const Vec2< T > &point) const noexcept
     
    + + + + + + + + + +

    +Public Attributes

    T left
     
    T top
     
    T width
     
    T height
     
    + + + +

    +Friends

    constexpr friend std::ostream & operator<< (std::ostream &os, const Rect< T > &rect) noexcept
     
    +

    Constructor & Destructor Documentation

    + +

    ◆ Rect() [1/3]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + +
    constexpr vulk::Rect< T >::Rect ()
    +     		+constexprdefault
    +
    + +
    +
    + +

    ◆ Rect() [2/3]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    constexpr vulk::Rect< T >::Rect (T aLeft,
    T aTop,
    T aWidth,
    T aHeight 
    )
    +     		+inlineconstexpr
    +
    + +
    +
    + +

    ◆ Rect() [3/3]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr vulk::Rect< T >::Rect (const Vec2< T > & pos,
    const Vec2< T > & size 
    )
    +     		+inlineconstexpr
    +
    + +
    +
    +

    Member Function Documentation

    + +

    ◆ contains() [1/2]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    constexpr bool vulk::Rect< T >::contains (const Vec2< T > & point) const
    +     		+inlineconstexprnoexcept
    +
    + +
    +
    + +

    ◆ contains() [2/2]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr bool vulk::Rect< T >::contains (T x,
    T y 
    ) const
    +     		+inlineconstexprnoexcept
    +
    + +
    +
    + +

    ◆ operator!=()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    constexpr bool vulk::Rect< T >::operator!= (const Rect< T > & right) const
    +     		+inlineconstexprnoexcept
    +
    + +
    +
    + +

    ◆ operator==()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    constexpr bool vulk::Rect< T >::operator== (const Rect< T > & right) const
    +     		+inlineconstexprnoexcept
    +
    + +
    +
    +

    Friends And Related Function Documentation

    + +

    ◆ operator<<

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr friend std::ostream & operator<< (std::ostream & os,
    const Rect< T > & rect 
    )
    +     		+friend
    +
    + +
    +
    +

    Member Data Documentation

    + +

    ◆ height

    + +
    +
    +
    +template<typename T >
    + + + + +
    T vulk::Rect< T >::height
    +
    + +
    +
    + +

    ◆ left

    + +
    +
    +
    +template<typename T >
    + + + + +
    T vulk::Rect< T >::left
    +
    + +
    +
    + +

    ◆ top

    + +
    +
    +
    +template<typename T >
    + + + + +
    T vulk::Rect< T >::top
    +
    + +
    +
    + +

    ◆ width

    + +
    +
    +
    +template<typename T >
    + + + + +
    T vulk::Rect< T >::width
    +
    + +
    +
    +
    The documentation for this struct was generated from the following file: +
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/structvulk_1_1_vec2-members.html b/docs/html/structvulk_1_1_vec2-members.html new file mode 100644 index 0000000..c8a6467 --- /dev/null +++ b/docs/html/structvulk_1_1_vec2-members.html @@ -0,0 +1,74 @@ + + + + + + + +Vulk: Member List + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + + +
    +
    +
    vulk::Vec2< T > Member List
    +
    +
    + +

    This is the complete list of members for vulk::Vec2< T >, including all inherited members.

    + + + + + + + + + + + + + + + + + +
    cross(const Vec2 &lhs, const Vec2 &rhs) noexceptvulk::Vec2< T >inlinestatic
    dot(const Vec2 &lhs, const Vec2 &rhs) noexceptvulk::Vec2< T >inlinestatic
    length() const noexceptvulk::Vec2< T >inline
    lengthSquared() const noexceptvulk::Vec2< T >inline
    normalized() const noexceptvulk::Vec2< T >inline
    operator*=(const T value)vulk::Vec2< T >inline
    operator+=(const Vec2 &rhs)vulk::Vec2< T >inline
    operator-() const noexceptvulk::Vec2< T >inline
    operator-=(const Vec2 &rhs)vulk::Vec2< T >inline
    operator/=(const T value)vulk::Vec2< T >inline
    operator<<vulk::Vec2< T >friend
    Vec2()=defaultvulk::Vec2< T >
    Vec2(T aX, T aY)vulk::Vec2< T >inline
    Vec2(T value)vulk::Vec2< T >inlineexplicit
    xvulk::Vec2< T >
    yvulk::Vec2< T >
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/structvulk_1_1_vec2.html b/docs/html/structvulk_1_1_vec2.html new file mode 100644 index 0000000..d62f2da --- /dev/null +++ b/docs/html/structvulk_1_1_vec2.html @@ -0,0 +1,574 @@ + + + + + + + +Vulk: vulk::Vec2< T > Struct Template Reference + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +Public Attributes | +Friends | +List of all members
    +
    vulk::Vec2< T > Struct Template Reference
    +
    +
    + +

    #include <Vec2.hpp>

    + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    constexpr Vec2 ()=default
     
    constexpr Vec2 (T aX, T aY)
     
    constexpr Vec2 (T value)
     
    constexpr Vec2 operator- () const noexcept
     
    constexpr Vec2 & operator+= (const Vec2 &rhs)
     
    constexpr Vec2 & operator-= (const Vec2 &rhs)
     
    constexpr Vec2 & operator*= (const T value)
     
    constexpr Vec2 & operator/= (const T value)
     
    constexpr T lengthSquared () const noexcept
     
    constexpr T length () const noexcept
     
    constexpr Vec2 normalized () const noexcept
     
    + + + + + +

    +Static Public Member Functions

    static constexpr T dot (const Vec2 &lhs, const Vec2 &rhs) noexcept
     
    static constexpr T cross (const Vec2 &lhs, const Vec2 &rhs) noexcept
     
    + + + + + +

    +Public Attributes

    T x
     
    T y
     
    + + + +

    +Friends

    constexpr friend std::ostream & operator<< (std::ostream &os, const Vec2 &Vec2) noexcept
     
    +

    Constructor & Destructor Documentation

    + +

    ◆ Vec2() [1/3]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + +
    constexpr vulk::Vec2< T >::Vec2 ()
    +     		+constexprdefault
    +
    + +
    +
    + +

    ◆ Vec2() [2/3]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr vulk::Vec2< T >::Vec2 (T aX,
    T aY 
    )
    +     		+inlineconstexpr
    +
    + +
    +
    + +

    ◆ Vec2() [3/3]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    constexpr vulk::Vec2< T >::Vec2 (T value)
    +     		+inlineexplicitconstexpr
    +
    + +
    +
    +

    Member Function Documentation

    + +

    ◆ cross()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    static constexpr T vulk::Vec2< T >::cross (const Vec2< T > & lhs,
    const Vec2< T > & rhs 
    )
    +     		+inlinestaticconstexprnoexcept
    +
    + +
    +
    + +

    ◆ dot()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    static constexpr T vulk::Vec2< T >::dot (const Vec2< T > & lhs,
    const Vec2< T > & rhs 
    )
    +     		+inlinestaticconstexprnoexcept
    +
    + +
    +
    + +

    ◆ length()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + +
    constexpr T vulk::Vec2< T >::length () const
    +     		+inlineconstexprnoexcept
    +
    + +
    +
    + +

    ◆ lengthSquared()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + +
    constexpr T vulk::Vec2< T >::lengthSquared () const
    +     		+inlineconstexprnoexcept
    +
    + +
    +
    + +

    ◆ normalized()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + +
    constexpr Vec2 vulk::Vec2< T >::normalized () const
    +     		+inlineconstexprnoexcept
    +
    + +
    +
    + +

    ◆ operator*=()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    constexpr Vec2 & vulk::Vec2< T >::operator*= (const T value)
    +     		+inlineconstexpr
    +
    + +
    +
    + +

    ◆ operator+=()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    constexpr Vec2 & vulk::Vec2< T >::operator+= (const Vec2< T > & rhs)
    +     		+inlineconstexpr
    +
    + +
    +
    + +

    ◆ operator-()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + +
    constexpr Vec2 vulk::Vec2< T >::operator- () const
    +     		+inlineconstexprnoexcept
    +
    + +
    +
    + +

    ◆ operator-=()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    constexpr Vec2 & vulk::Vec2< T >::operator-= (const Vec2< T > & rhs)
    +     		+inlineconstexpr
    +
    + +
    +
    + +

    ◆ operator/=()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    constexpr Vec2 & vulk::Vec2< T >::operator/= (const T value)
    +     		+inlineconstexpr
    +
    + +
    +
    +

    Friends And Related Function Documentation

    + +

    ◆ operator<<

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr friend std::ostream & operator<< (std::ostream & os,
    const Vec2< T > & Vec2 
    )
    +     		+friend
    +
    + +
    +
    +

    Member Data Documentation

    + +

    ◆ x

    + +
    +
    +
    +template<typename T >
    + + + + +
    T vulk::Vec2< T >::x
    +
    + +
    +
    + +

    ◆ y

    + +
    +
    +
    +template<typename T >
    + + + + +
    T vulk::Vec2< T >::y
    +
    + +
    +
    +
    The documentation for this struct was generated from the following file: +
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/structvulk_1_1_vec3-members.html b/docs/html/structvulk_1_1_vec3-members.html new file mode 100644 index 0000000..f7fc6af --- /dev/null +++ b/docs/html/structvulk_1_1_vec3-members.html @@ -0,0 +1,75 @@ + + + + + + + +Vulk: Member List + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + + +
    +
    +
    vulk::Vec3< T > Member List
    +
    +
    + +

    This is the complete list of members for vulk::Vec3< T >, including all inherited members.

    + + + + + + + + + + + + + + + + + + +
    cross(const Vec3 &lhs, const Vec3 &rhs) noexceptvulk::Vec3< T >inlinestatic
    dot(const Vec3 &lhs, const Vec3 &rhs) noexceptvulk::Vec3< T >inlinestatic
    length() const noexceptvulk::Vec3< T >inline
    lengthSquared() const noexceptvulk::Vec3< T >inline
    normalized() const noexceptvulk::Vec3< T >inline
    operator*=(const T value)vulk::Vec3< T >inline
    operator+=(const Vec3 &rhs)vulk::Vec3< T >inline
    operator-() const noexceptvulk::Vec3< T >inline
    operator-=(const Vec3 &rhs)vulk::Vec3< T >inline
    operator/=(const T value)vulk::Vec3< T >inline
    operator<<vulk::Vec3< T >friend
    Vec3()=defaultvulk::Vec3< T >
    Vec3(T aX, T aY, T aZ)vulk::Vec3< T >inline
    Vec3(T value)vulk::Vec3< T >inlineexplicit
    xvulk::Vec3< T >
    yvulk::Vec3< T >
    zvulk::Vec3< T >
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/structvulk_1_1_vec3.html b/docs/html/structvulk_1_1_vec3.html new file mode 100644 index 0000000..d2ca11c --- /dev/null +++ b/docs/html/structvulk_1_1_vec3.html @@ -0,0 +1,598 @@ + + + + + + + +Vulk: vulk::Vec3< T > Struct Template Reference + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +Public Attributes | +Friends | +List of all members
    +
    vulk::Vec3< T > Struct Template Reference
    +
    +
    + +

    #include <Vec3.hpp>

    + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    constexpr Vec3 ()=default
     
    constexpr Vec3 (T aX, T aY, T aZ)
     
    constexpr Vec3 (T value)
     
    constexpr Vec3 operator- () const noexcept
     
    constexpr Vec3 & operator+= (const Vec3 &rhs)
     
    constexpr Vec3 & operator-= (const Vec3 &rhs)
     
    constexpr Vec3 & operator*= (const T value)
     
    constexpr Vec3 & operator/= (const T value)
     
    constexpr T lengthSquared () const noexcept
     
    constexpr T length () const noexcept
     
    constexpr Vec3 normalized () const noexcept
     
    + + + + + +

    +Static Public Member Functions

    static constexpr T dot (const Vec3 &lhs, const Vec3 &rhs) noexcept
     
    static constexpr Vec3 cross (const Vec3 &lhs, const Vec3 &rhs) noexcept
     
    + + + + + + + +

    +Public Attributes

    T x
     
    T y
     
    T z
     
    + + + +

    +Friends

    constexpr friend std::ostream & operator<< (std::ostream &os, const Vec3 &vec3) noexcept
     
    +

    Constructor & Destructor Documentation

    + +

    ◆ Vec3() [1/3]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + +
    constexpr vulk::Vec3< T >::Vec3 ()
    +     		+constexprdefault
    +
    + +
    +
    + +

    ◆ Vec3() [2/3]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    constexpr vulk::Vec3< T >::Vec3 (T aX,
    T aY,
    T aZ 
    )
    +     		+inlineconstexpr
    +
    + +
    +
    + +

    ◆ Vec3() [3/3]

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    constexpr vulk::Vec3< T >::Vec3 (T value)
    +     		+inlineexplicitconstexpr
    +
    + +
    +
    +

    Member Function Documentation

    + +

    ◆ cross()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    static constexpr Vec3 vulk::Vec3< T >::cross (const Vec3< T > & lhs,
    const Vec3< T > & rhs 
    )
    +     		+inlinestaticconstexprnoexcept
    +
    + +
    +
    + +

    ◆ dot()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    static constexpr T vulk::Vec3< T >::dot (const Vec3< T > & lhs,
    const Vec3< T > & rhs 
    )
    +     		+inlinestaticconstexprnoexcept
    +
    + +
    +
    + +

    ◆ length()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + +
    constexpr T vulk::Vec3< T >::length () const
    +     		+inlineconstexprnoexcept
    +
    + +
    +
    + +

    ◆ lengthSquared()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + +
    constexpr T vulk::Vec3< T >::lengthSquared () const
    +     		+inlineconstexprnoexcept
    +
    + +
    +
    + +

    ◆ normalized()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + +
    constexpr Vec3 vulk::Vec3< T >::normalized () const
    +     		+inlineconstexprnoexcept
    +
    + +
    +
    + +

    ◆ operator*=()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    constexpr Vec3 & vulk::Vec3< T >::operator*= (const T value)
    +     		+inlineconstexpr
    +
    + +
    +
    + +

    ◆ operator+=()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    constexpr Vec3 & vulk::Vec3< T >::operator+= (const Vec3< T > & rhs)
    +     		+inlineconstexpr
    +
    + +
    +
    + +

    ◆ operator-()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + +
    constexpr Vec3 vulk::Vec3< T >::operator- () const
    +     		+inlineconstexprnoexcept
    +
    + +
    +
    + +

    ◆ operator-=()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    constexpr Vec3 & vulk::Vec3< T >::operator-= (const Vec3< T > & rhs)
    +     		+inlineconstexpr
    +
    + +
    +
    + +

    ◆ operator/=()

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + +
    constexpr Vec3 & vulk::Vec3< T >::operator/= (const T value)
    +     		+inlineconstexpr
    +
    + +
    +
    +

    Friends And Related Function Documentation

    + +

    ◆ operator<<

    + +
    +
    +
    +template<typename T >
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    constexpr friend std::ostream & operator<< (std::ostream & os,
    const Vec3< T > & vec3 
    )
    +     		+friend
    +
    + +
    +
    +

    Member Data Documentation

    + +

    ◆ x

    + +
    +
    +
    +template<typename T >
    + + + + +
    T vulk::Vec3< T >::x
    +
    + +
    +
    + +

    ◆ y

    + +
    +
    +
    +template<typename T >
    + + + + +
    T vulk::Vec3< T >::y
    +
    + +
    +
    + +

    ◆ z

    + +
    +
    +
    +template<typename T >
    + + + + +
    T vulk::Vec3< T >::z
    +
    + +
    +
    +
    The documentation for this struct was generated from the following file: +
    + +
    +Generated by doxygen 1.9.3 +
    + + diff --git a/docs/html/sync_off.png b/docs/html/sync_off.png new file mode 100644 index 0000000000000000000000000000000000000000..3b443fc62892114406e3d399421b2a881b897acc GIT binary patch literal 853 zcmV-b1FHOqP)oT|#XixUYy%lpuf3i8{fX!o zUyDD0jOrAiT^tq>fLSOOABs-#u{dV^F$b{L9&!2=9&RmV;;8s^x&UqB$PCj4FdKbh zoB1WTskPUPu05XzFbA}=KZ-GP1fPpAfSs>6AHb12UlR%-i&uOlTpFNS7{jm@mkU1V zh`nrXr~+^lsV-s1dkZOaI|kYyVj3WBpPCY{n~yd%u%e+d=f%`N0FItMPtdgBb@py; zq@v6NVArhyTC7)ULw-Jy8y42S1~4n(3LkrW8mW(F-4oXUP3E`e#g**YyqI7h-J2zK zK{m9##m4ri!7N>CqQqCcnI3hqo1I;Yh&QLNY4T`*ptiQGozK>FF$!$+84Z`xwmeMh zJ0WT+OH$WYFALEaGj2_l+#DC3t7_S`vHpSivNeFbP6+r50cO8iu)`7i%Z4BTPh@_m3Tk!nAm^)5Bqnr%Ov|Baunj#&RPtRuK& z4RGz|D5HNrW83-#ydk}tVKJrNmyYt-sTxLGlJY5nc&Re zU4SgHNPx8~Yxwr$bsju?4q&%T1874xxzq+_%?h8_ofw~(bld=o3iC)LUNR*BY%c0y zWd_jX{Y8`l%z+ol1$@Qa?Cy!(0CVIEeYpKZ`(9{z>3$CIe;pJDQk$m3p}$>xBm4lb zKo{4S)`wdU9Ba9jJbVJ0C=SOefZe%d$8=2r={nu<_^a3~>c#t_U6dye5)JrR(_a^E f@}b6j1K9lwFJq@>o)+Ry00000NkvXXu0mjfWa5j* literal 0 HcmV?d00001 diff --git a/docs/html/sync_on.png b/docs/html/sync_on.png new file mode 100644 index 0000000000000000000000000000000000000000..e08320fb64e6fa33b573005ed6d8fe294e19db76 GIT binary patch literal 845 zcmV-T1G4;yP)Y;xxyHF2B5Wzm| zOOGupOTn@c(JmBOl)e;XMNnZuiTJP>rM8<|Q`7I_))aP?*T)ow&n59{}X4$3Goat zgjs?*aasfbrokzG5cT4K=uG`E14xZl@z)F={P0Y^?$4t z>v!teRnNZym<6h{7sLyF1V0HsfEl+l6TrZpsfr1}luH~F7L}ktXu|*uVX^RG$L0`K zWs3j|0tIvVe(N%_?2{(iCPFGf#B6Hjy6o&}D$A%W%jfO8_W%ZO#-mh}EM$LMn7joJ z05dHr!5Y92g+31l<%i1(=L1a1pXX+OYnalY>31V4K}BjyRe3)9n#;-cCVRD_IG1fT zOKGeNY8q;TL@K{dj@D^scf&VCs*-Jb>8b>|`b*osv52-!A?BpbYtTQBns5EAU**$m zSnVSm(teh>tQi*S*A>#ySc=n;`BHz`DuG4&g4Kf8lLhca+zvZ7t7RflD6-i-mcK=M z!=^P$*u2)bkY5asG4gsss!Hn%u~>}kIW`vMs%lJLH+u*9<4PaV_c6U`KqWXQH%+Nu zTv41O(^ZVi@qhjQdG!fbZw&y+2o!iYymO^?ud3{P*HdoX83YV*Uu_HB=?U&W9%AU# z80}k1SS-CXTU7dcQlsm<^oYLxVSseqY6NO}dc`Nj?8vrhNuCdm@^{a3AQ_>6myOj+ z`1RsLUXF|dm|3k7s2jD(B{rzE>WI2scH8i1;=O5Cc9xB3^aJk%fQjqsu+kH#0=_5a z0nCE8@dbQa-|YIuUVvG0L_IwHMEhOj$Mj4Uq05 X8=0q~qBNan00000NkvXXu0mjfptF>5 literal 0 HcmV?d00001 diff --git a/docs/html/tab_a.png b/docs/html/tab_a.png new file mode 100644 index 0000000000000000000000000000000000000000..3b725c41c5a527a3a3e40097077d0e206a681247 GIT binary patch literal 142 zcmeAS@N?(olHy`uVBq!ia0vp^j6kfy!2~3aiye;!QlXwMjv*C{Z|8b*H5dputLHD# z=<0|*y7z(Vor?d;H&?EG&cXR}?!j-Lm&u1OOI7AIF5&c)RFE;&p0MYK>*Kl@eiymD r@|NpwKX@^z+;{u_Z~trSBfrMKa%3`zocFjEXaR$#tDnm{r-UW|TZ1%4 literal 0 HcmV?d00001 diff --git a/docs/html/tab_b.png b/docs/html/tab_b.png new file mode 100644 index 0000000000000000000000000000000000000000..e2b4a8638cb3496a016eaed9e16ffc12846dea18 GIT binary patch literal 169 zcmeAS@N?(olHy`uVBq!ia0vp^j6kfy!2~3aiye;!QU#tajv*C{Z}0l@H7kg?K0Lnr z!j&C6_(~HV9oQ0Pa6x{-v0AGV_E?vLn=ZI-;YrdjIl`U`uzuDWSP?o#Dmo{%SgM#oan kX~E1%D-|#H#QbHoIja2U-MgvsK&LQxy85}Sb4q9e0Efg%P5=M^ literal 0 HcmV?d00001 diff --git a/docs/html/tabs.css b/docs/html/tabs.css new file mode 100644 index 0000000..00d1c60 --- /dev/null +++ b/docs/html/tabs.css @@ -0,0 +1 @@ +.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:#666;-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:url("tab_b.png")}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:"Lucida Grande","Geneva","Helvetica",Arial,sans-serif;font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:0 1px 1px rgba(255,255,255,0.9);color:#283a5d;outline:0}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:rgba(255,255,255,0.5);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:rgba(162,162,162,0.1)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:white;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:url("tab_b.png");line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:#283a5d transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:url("tab_s.png");background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a:hover span.sub-arrow{border-color:white transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent #fff transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:#fff;-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent #555;border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:#555;background-image:none;border:0 !important;color:#555;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent white}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:#fff;height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent #555 transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:#555 transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:url("tab_b.png")}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:#fff}} \ No newline at end of file From f8c09f8b21ea44121c936627fe6958bd594f3d28 Mon Sep 17 00:00:00 2001 From: Benjamin Praud Date: Sun, 27 Feb 2022 22:47:42 +0100 Subject: [PATCH 2/8] feat: generate doc at the build if option enabled --- CMakeLists.txt | 4 +- cmake/Doxygen.cmake | 24 + documentation/Doxyfile.in | 2702 +++++++++++++++++ .../html/_class_utils_8hpp.html | 10 +- .../html/_class_utils_8hpp_source.html | 10 +- documentation/html/_context_g_l_f_w_8cpp.html | 60 + .../html/_context_g_l_f_w_8hpp.html | 10 +- .../html/_context_g_l_f_w_8hpp_source.html | 20 +- documentation/html/_context_vulkan_8cpp.html | 67 + .../html/_context_vulkan_8hpp.html | 10 +- .../html/_context_vulkan_8hpp_source.html | 28 +- documentation/html/_exceptions_8cpp.html | 58 + .../html/_exceptions_8hpp.html | 10 +- .../html/_exceptions_8hpp_source.html | 22 +- documentation/html/_frame_manager_8cpp.html | 94 + .../html/_frame_manager_8hpp.html | 10 +- .../html/_frame_manager_8hpp_source.html | 30 +- documentation/html/_keyboard_8cpp.html | 58 + .../html/_keyboard_8hpp.html | 10 +- .../html/_keyboard_8hpp_source.html | 22 +- {docs => documentation}/html/_mat3_8hpp.html | 10 +- .../html/_mat3_8hpp_source.html | 10 +- documentation/html/_mouse_8cpp.html | 58 + {docs => documentation}/html/_mouse_8hpp.html | 10 +- .../html/_mouse_8hpp_source.html | 22 +- documentation/html/_objects_8cpp.html | 56 + .../html/_objects_8hpp.html | 10 +- .../html/_objects_8hpp_source.html | 18 +- {docs => documentation}/html/_rect_8hpp.html | 10 +- .../html/_rect_8hpp_source.html | 10 +- documentation/html/_scoped_profiler_8cpp.html | 58 + .../html/_scoped_profiler_8hpp.html | 10 +- .../html/_scoped_profiler_8hpp_source.html | 18 +- documentation/html/_shader_8cpp.html | 60 + .../html/_shader_8hpp.html | 10 +- .../html/_shader_8hpp_source.html | 18 +- {docs => documentation}/html/_time_8hpp.html | 10 +- .../html/_time_8hpp_source.html | 10 +- documentation/html/_utils_8cpp.html | 59 + {docs => documentation}/html/_utils_8hpp.html | 10 +- .../html/_utils_8hpp_source.html | 14 +- {docs => documentation}/html/_vec2_8hpp.html | 10 +- .../html/_vec2_8hpp_source.html | 18 +- {docs => documentation}/html/_vec3_8hpp.html | 10 +- .../html/_vec3_8hpp_source.html | 18 +- documentation/html/_window_8cpp.html | 61 + .../html/_window_8hpp.html | 10 +- .../html/_window_8hpp_source.html | 93 +- {docs => documentation}/html/annotated.html | 10 +- {docs => documentation}/html/bc_s.png | Bin {docs => documentation}/html/bdwn.png | Bin .../html/class_type_checker.html | 10 +- {docs => documentation}/html/classes.html | 10 +- ...classvulk_1_1_context_g_l_f_w-members.html | 12 +- .../html/classvulk_1_1_context_g_l_f_w.html | 23 +- .../classvulk_1_1_context_vulkan-members.html | 14 +- .../html/classvulk_1_1_context_vulkan.html | 35 +- .../html/classvulk_1_1_exception-members.html | 10 +- .../html/classvulk_1_1_exception.html | 10 +- .../html/classvulk_1_1_exception.png | Bin .../classvulk_1_1_frame_manager-members.html | 12 +- .../html/classvulk_1_1_frame_manager.html | 23 +- ...assvulk_1_1_g_l_f_w_exception-members.html | 12 +- .../html/classvulk_1_1_g_l_f_w_exception.html | 27 +- .../html/classvulk_1_1_g_l_f_w_exception.png | Bin .../html/classvulk_1_1_keyboard-members.html | 10 +- .../html/classvulk_1_1_keyboard.html | 13 +- .../html/classvulk_1_1_mouse-members.html | 10 +- .../html/classvulk_1_1_mouse.html | 13 +- .../html/classvulk_1_1_shader-members.html | 10 +- .../html/classvulk_1_1_shader.html | 13 +- ...lassvulk_1_1_vulkan_exception-members.html | 10 +- .../html/classvulk_1_1_vulkan_exception.html | 13 +- .../html/classvulk_1_1_vulkan_exception.png | Bin .../html/classvulk_1_1_window-members.html | 12 +- .../html/classvulk_1_1_window.html | 64 +- ..._1_1utils_1_1_scoped_profiler-members.html | 10 +- ...lassvulk_1_1utils_1_1_scoped_profiler.html | 13 +- {docs => documentation}/html/closed.png | Bin .../dir_5a30104352ef4255dc24354b02eb2d20.html | 10 +- .../dir_97aefd0d527b934f1d99a682da8fe6a9.html | 12 +- .../dir_a065c5f60305fee3569f887679366939.html | 82 + .../dir_b80377379080ab8697acea2877ef94f6.html | 10 +- .../dir_bbfa40afa4c57c6dadf08b9016d8766e.html | 10 +- .../dir_c0c89e754f12c21eba9abb941d03e27f.html | 63 + {docs => documentation}/html/doc.png | Bin {docs => documentation}/html/doxygen.css | 20 +- {docs => documentation}/html/doxygen.svg | 0 {docs => documentation}/html/dynsections.js | 0 {docs => documentation}/html/files.html | 23 +- {docs => documentation}/html/folderclosed.png | Bin {docs => documentation}/html/folderopen.png | Bin {docs => documentation}/html/functions.html | 28 +- .../html/functions_func.html | 28 +- .../html/functions_rela.html | 10 +- .../html/functions_type.html | 10 +- .../html/functions_vars.html | 10 +- {docs => documentation}/html/globals.html | 12 +- .../html/globals_defs.html | 10 +- .../html/globals_func.html | 12 +- {docs => documentation}/html/hierarchy.html | 10 +- {docs => documentation}/html/index.html | 10 +- {docs => documentation}/html/jquery.js | 0 {docs => documentation}/html/menu.js | 0 {docs => documentation}/html/menudata.js | 0 .../html/namespacemembers.html | 10 +- .../html/namespacemembers_enum.html | 10 +- .../html/namespacemembers_func.html | 10 +- .../html/namespacemembers_type.html | 10 +- {docs => documentation}/html/namespaces.html | 10 +- .../html/namespacevulk.html | 10 +- .../html/namespacevulk_1_1utils.html | 10 +- {docs => documentation}/html/nav_f.png | Bin {docs => documentation}/html/nav_g.png | Bin {docs => documentation}/html/nav_h.png | Bin {docs => documentation}/html/open.png | Bin {docs => documentation}/html/splitbar.png | Bin .../struct_uniform_buffer_object-members.html | 10 +- .../html/struct_uniform_buffer_object.html | 10 +- .../html/struct_vertex-members.html | 14 +- .../html/struct_vertex.html | 33 +- .../html/structvulk_1_1_mat3-members.html | 10 +- .../html/structvulk_1_1_mat3.html | 18 +- .../html/structvulk_1_1_rect-members.html | 10 +- .../html/structvulk_1_1_rect.html | 16 +- .../html/structvulk_1_1_vec2-members.html | 14 +- .../html/structvulk_1_1_vec2.html | 36 +- .../html/structvulk_1_1_vec3-members.html | 14 +- .../html/structvulk_1_1_vec3.html | 36 +- {docs => documentation}/html/sync_off.png | Bin {docs => documentation}/html/sync_on.png | Bin {docs => documentation}/html/tab_a.png | Bin {docs => documentation}/html/tab_b.png | Bin {docs => documentation}/html/tab_h.png | Bin {docs => documentation}/html/tab_s.png | Bin {docs => documentation}/html/tabs.css | 0 136 files changed, 4279 insertions(+), 751 deletions(-) create mode 100644 cmake/Doxygen.cmake create mode 100644 documentation/Doxyfile.in rename {docs => documentation}/html/_class_utils_8hpp.html (98%) rename {docs => documentation}/html/_class_utils_8hpp_source.html (98%) create mode 100644 documentation/html/_context_g_l_f_w_8cpp.html rename {docs => documentation}/html/_context_g_l_f_w_8hpp.html (94%) rename {docs => documentation}/html/_context_g_l_f_w_8hpp_source.html (90%) create mode 100644 documentation/html/_context_vulkan_8cpp.html rename {docs => documentation}/html/_context_vulkan_8hpp.html (95%) rename {docs => documentation}/html/_context_vulkan_8hpp_source.html (95%) create mode 100644 documentation/html/_exceptions_8cpp.html rename {docs => documentation}/html/_exceptions_8hpp.html (98%) rename {docs => documentation}/html/_exceptions_8hpp_source.html (91%) create mode 100644 documentation/html/_frame_manager_8cpp.html rename {docs => documentation}/html/_frame_manager_8hpp.html (96%) rename {docs => documentation}/html/_frame_manager_8hpp_source.html (88%) create mode 100644 documentation/html/_keyboard_8cpp.html rename {docs => documentation}/html/_keyboard_8hpp.html (99%) rename {docs => documentation}/html/_keyboard_8hpp_source.html (98%) rename {docs => documentation}/html/_mat3_8hpp.html (94%) rename {docs => documentation}/html/_mat3_8hpp_source.html (99%) create mode 100644 documentation/html/_mouse_8cpp.html rename {docs => documentation}/html/_mouse_8hpp.html (96%) rename {docs => documentation}/html/_mouse_8hpp_source.html (94%) create mode 100644 documentation/html/_objects_8cpp.html rename {docs => documentation}/html/_objects_8hpp.html (94%) rename {docs => documentation}/html/_objects_8hpp_source.html (88%) rename {docs => documentation}/html/_rect_8hpp.html (96%) rename {docs => documentation}/html/_rect_8hpp_source.html (99%) create mode 100644 documentation/html/_scoped_profiler_8cpp.html rename {docs => documentation}/html/_scoped_profiler_8hpp.html (97%) rename {docs => documentation}/html/_scoped_profiler_8hpp_source.html (94%) create mode 100644 documentation/html/_shader_8cpp.html rename {docs => documentation}/html/_shader_8hpp.html (94%) rename {docs => documentation}/html/_shader_8hpp_source.html (92%) rename {docs => documentation}/html/_time_8hpp.html (95%) rename {docs => documentation}/html/_time_8hpp_source.html (97%) create mode 100644 documentation/html/_utils_8cpp.html rename {docs => documentation}/html/_utils_8hpp.html (95%) rename {docs => documentation}/html/_utils_8hpp_source.html (93%) rename {docs => documentation}/html/_vec2_8hpp.html (97%) rename {docs => documentation}/html/_vec2_8hpp_source.html (97%) rename {docs => documentation}/html/_vec3_8hpp.html (97%) rename {docs => documentation}/html/_vec3_8hpp_source.html (97%) create mode 100644 documentation/html/_window_8cpp.html rename {docs => documentation}/html/_window_8hpp.html (94%) rename {docs => documentation}/html/_window_8hpp_source.html (65%) rename {docs => documentation}/html/annotated.html (97%) rename {docs => documentation}/html/bc_s.png (100%) rename {docs => documentation}/html/bdwn.png (100%) rename {docs => documentation}/html/class_type_checker.html (93%) rename {docs => documentation}/html/classes.html (96%) rename {docs => documentation}/html/classvulk_1_1_context_g_l_f_w-members.html (92%) rename {docs => documentation}/html/classvulk_1_1_context_g_l_f_w.html (86%) rename {docs => documentation}/html/classvulk_1_1_context_vulkan-members.html (91%) rename {docs => documentation}/html/classvulk_1_1_context_vulkan.html (84%) rename {docs => documentation}/html/classvulk_1_1_exception-members.html (95%) rename {docs => documentation}/html/classvulk_1_1_exception.html (98%) rename {docs => documentation}/html/classvulk_1_1_exception.png (100%) rename {docs => documentation}/html/classvulk_1_1_frame_manager-members.html (94%) rename {docs => documentation}/html/classvulk_1_1_frame_manager.html (93%) rename {docs => documentation}/html/classvulk_1_1_g_l_f_w_exception-members.html (91%) rename {docs => documentation}/html/classvulk_1_1_g_l_f_w_exception.html (82%) rename {docs => documentation}/html/classvulk_1_1_g_l_f_w_exception.png (100%) rename {docs => documentation}/html/classvulk_1_1_keyboard-members.html (95%) rename {docs => documentation}/html/classvulk_1_1_keyboard.html (96%) rename {docs => documentation}/html/classvulk_1_1_mouse-members.html (94%) rename {docs => documentation}/html/classvulk_1_1_mouse.html (97%) rename {docs => documentation}/html/classvulk_1_1_shader-members.html (94%) rename {docs => documentation}/html/classvulk_1_1_shader.html (96%) rename {docs => documentation}/html/classvulk_1_1_vulkan_exception-members.html (94%) rename {docs => documentation}/html/classvulk_1_1_vulkan_exception.html (95%) rename {docs => documentation}/html/classvulk_1_1_vulkan_exception.png (100%) rename {docs => documentation}/html/classvulk_1_1_window-members.html (95%) rename {docs => documentation}/html/classvulk_1_1_window.html (84%) rename {docs => documentation}/html/classvulk_1_1utils_1_1_scoped_profiler-members.html (96%) rename {docs => documentation}/html/classvulk_1_1utils_1_1_scoped_profiler.html (98%) rename {docs => documentation}/html/closed.png (100%) rename {docs => documentation}/html/dir_5a30104352ef4255dc24354b02eb2d20.html (92%) rename {docs => documentation}/html/dir_97aefd0d527b934f1d99a682da8fe6a9.html (82%) create mode 100644 documentation/html/dir_a065c5f60305fee3569f887679366939.html rename {docs => documentation}/html/dir_b80377379080ab8697acea2877ef94f6.html (94%) rename {docs => documentation}/html/dir_bbfa40afa4c57c6dadf08b9016d8766e.html (97%) create mode 100644 documentation/html/dir_c0c89e754f12c21eba9abb941d03e27f.html rename {docs => documentation}/html/doc.png (100%) rename {docs => documentation}/html/doxygen.css (99%) rename {docs => documentation}/html/doxygen.svg (100%) rename {docs => documentation}/html/dynsections.js (100%) rename {docs => documentation}/html/files.html (70%) rename {docs => documentation}/html/folderclosed.png (100%) rename {docs => documentation}/html/folderopen.png (100%) rename {docs => documentation}/html/functions.html (93%) rename {docs => documentation}/html/functions_func.html (92%) rename {docs => documentation}/html/functions_rela.html (91%) rename {docs => documentation}/html/functions_type.html (93%) rename {docs => documentation}/html/functions_vars.html (95%) rename {docs => documentation}/html/globals.html (91%) rename {docs => documentation}/html/globals_defs.html (93%) rename {docs => documentation}/html/globals_func.html (84%) rename {docs => documentation}/html/hierarchy.html (97%) rename {docs => documentation}/html/index.html (89%) rename {docs => documentation}/html/jquery.js (100%) rename {docs => documentation}/html/menu.js (100%) rename {docs => documentation}/html/menudata.js (100%) rename {docs => documentation}/html/namespacemembers.html (96%) rename {docs => documentation}/html/namespacemembers_enum.html (90%) rename {docs => documentation}/html/namespacemembers_func.html (92%) rename {docs => documentation}/html/namespacemembers_type.html (94%) rename {docs => documentation}/html/namespaces.html (97%) rename {docs => documentation}/html/namespacevulk.html (99%) rename {docs => documentation}/html/namespacevulk_1_1utils.html (96%) rename {docs => documentation}/html/nav_f.png (100%) rename {docs => documentation}/html/nav_g.png (100%) rename {docs => documentation}/html/nav_h.png (100%) rename {docs => documentation}/html/open.png (100%) rename {docs => documentation}/html/splitbar.png (100%) rename {docs => documentation}/html/struct_uniform_buffer_object-members.html (93%) rename {docs => documentation}/html/struct_uniform_buffer_object.html (96%) rename {docs => documentation}/html/struct_vertex-members.html (90%) rename {docs => documentation}/html/struct_vertex.html (82%) rename {docs => documentation}/html/structvulk_1_1_mat3-members.html (96%) rename {docs => documentation}/html/structvulk_1_1_mat3.html (96%) rename {docs => documentation}/html/structvulk_1_1_rect-members.html (96%) rename {docs => documentation}/html/structvulk_1_1_rect.html (97%) rename {docs => documentation}/html/structvulk_1_1_vec2-members.html (95%) rename {docs => documentation}/html/structvulk_1_1_vec2.html (94%) rename {docs => documentation}/html/structvulk_1_1_vec3-members.html (95%) rename {docs => documentation}/html/structvulk_1_1_vec3.html (94%) rename {docs => documentation}/html/sync_off.png (100%) rename {docs => documentation}/html/sync_on.png (100%) rename {docs => documentation}/html/tab_a.png (100%) rename {docs => documentation}/html/tab_b.png (100%) rename {docs => documentation}/html/tab_h.png (100%) rename {docs => documentation}/html/tab_s.png (100%) rename {docs => documentation}/html/tabs.css (100%) diff --git a/CMakeLists.txt b/CMakeLists.txt index 5824906..b9be8e6 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -27,6 +27,8 @@ include(cmake/options.cmake) # *needs to be first* include(cmake/warnings.cmake) include(cmake/flags.cmake) include(cmake/functions.cmake) +include(cmake/Doxygen.cmake) +enable_doxygen() if (${CMAKE_BUILD_TYPE} MATCHES "Release" AND ${${PROJECT_PREFIX}_ENABLE_IPO}) include(CheckIPOSupported) @@ -42,4 +44,4 @@ add_subdirectory(lib) add_subdirectory(example-app) if (${PROJECT_PREFIX}_ENABLE_TESTING) add_subdirectory(tests) -endif() +endif() \ No newline at end of file diff --git a/cmake/Doxygen.cmake b/cmake/Doxygen.cmake new file mode 100644 index 0000000..5598c4a --- /dev/null +++ b/cmake/Doxygen.cmake @@ -0,0 +1,24 @@ +function(enable_doxygen) + option(ENABLE_DOXYGEN "Enable doxygen doc builder" OFF) + + if (ENABLE_DOXYGEN) + find_package(Doxygen) + if (NOT DOXYGEN_FOUND) + message(FATAL_ERROR "Doxygen is not installed") + endif() + + set(DOXYGEN_CALLER_GRAPH ON) + set(DOXYGEN_CALL_GRAPH ON) + set(DOXYGEN_EXTRACT_ALL ON) + + configure_file(${CMAKE_SOURCE_DIR}/documentation/Doxyfile.in ${CMAKE_BINARY_DIR}/documentation/Doxyfile @ONLY) + + add_custom_target( + doc_doxygen ALL + COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/documentation/Doxyfile + WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} + COMMENT "Generating documentation with doxygen" + VERBATIM + ) + endif() +endfunction() \ No newline at end of file diff --git a/documentation/Doxyfile.in b/documentation/Doxyfile.in new file mode 100644 index 0000000..c3790bb --- /dev/null +++ b/documentation/Doxyfile.in @@ -0,0 +1,2702 @@ +# Doxyfile 1.9.3 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = Vulk + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = @CMAKE_SOURCE_DIR@/documentation + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = lib + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.l \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS +# tag is set to YES then doxygen will add the directory of each input to the +# include path. +# The default value is: YES. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_ADD_INC_PATHS = YES + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /
    diff --git a/documentation/html/_context_vulkan_8hpp_source.html b/documentation/html/_context_vulkan_8hpp_source.html index 2bc9341..803cefb 100644 --- a/documentation/html/_context_vulkan_8hpp_source.html +++ b/documentation/html/_context_vulkan_8hpp_source.html @@ -288,7 +288,10 @@
    vulk::ContextVulkan::draw
    void draw()
    Definition: ContextVulkan.cpp:170
    vulk::ContextVulkan::getInstance
    static ContextVulkan & getInstance()
    Definition: ContextVulkan.cpp:1084
    vulk::ContextVulkan::setFrameBufferResized
    void setFrameBufferResized(bool value) noexcept
    Definition: ContextVulkan.hpp:45
    -
    vulk
    Definition: ContextGLFW.hpp:26
    +
    +
    vulk
    +
    Definition: Color.hpp:25
    +
    Vertex
    Definition: Objects.hpp:26
    diff --git a/documentation/html/_exceptions_8hpp_source.html b/documentation/html/_exceptions_8hpp_source.html index 5ae7119..74d78e2 100644 --- a/documentation/html/_exceptions_8hpp_source.html +++ b/documentation/html/_exceptions_8hpp_source.html @@ -178,7 +178,10 @@
    vulk::GLFWException
    Definition: Exceptions.hpp:74
    vulk::GLFWException::GLFWException
    GLFWException(const std::string &message=getGLFWError())
    Definition: Exceptions.hpp:76
    vulk::VulkanException
    Definition: Exceptions.hpp:82
    -
    vulk
    Definition: ContextGLFW.hpp:26
    +
    +
    vulk
    +
    Definition: Color.hpp:25
    +
    vulk::handleVulkanError
    vk::Result handleVulkanError(vk::Result res)
    Definition: Exceptions.hpp:89
    diff --git a/documentation/html/_frame_manager_8hpp_source.html b/documentation/html/_frame_manager_8hpp_source.html index ce226d3..87b48fc 100644 --- a/documentation/html/_frame_manager_8hpp_source.html +++ b/documentation/html/_frame_manager_8hpp_source.html @@ -66,62 +66,208 @@
    18 */
    19
    20#pragma once
    -
    21
    -
    22#include <array>
    -
    23#include <chrono>
    -
    24#include <functional>
    -
    25#include <optional>
    -
    26#include <string>
    -
    27
    -
    28#include "Time.hpp"
    -
    29
    -
    30namespace vulk {
    -
    31class FrameManager final
    -
    32{
    -
    33public:
    -
    34 using OnSecondCallback = std::function<void(const FrameManager& frameManager)>;
    -
    35 using FramerateStringBuffer = std::array<char, 16>;
    -
    36
    -
    37 FrameManager();
    -
    38
    -
    39 void update() noexcept;
    -
    40
    -
    41 void setOnSecondCallback(const OnSecondCallback& func) noexcept { m_onSecondCallback = func; }
    -
    42
    -
    43 [[nodiscard]] auto getDeltaTime() const noexcept { return m_deltaTime; }
    -
    44 [[nodiscard]] auto getFPS() const noexcept { return m_framerate; }
    -
    45 [[nodiscard]] FramerateStringBuffer getFramerateCString() const noexcept;
    -
    46 [[nodiscard]] std::string getFramerateString() const noexcept;
    -
    47
    -
    48private:
    -
    49 Duration m_duration{};
    -
    50 TimePoint m_lastFrame{};
    -
    51 TimePoint m_lastSecond{};
    -
    52
    -
    53 float m_deltaTime{};
    -
    54 uint32_t m_framerate{};
    -
    55 uint32_t m_frameCounter{};
    -
    56
    -
    57 std::optional<OnSecondCallback> m_onSecondCallback{std::nullopt};
    -
    58};
    -
    59} // namespace vulk
    -
    60
    -
    61std::ostream& operator<<(std::ostream& os, const vulk::FrameManager& frameManager);
    -
    operator<<
    std::ostream & operator<<(std::ostream &os, const vulk::FrameManager &frameManager)
    Definition: FrameManager.cpp:69
    - -
    vulk::FrameManager
    Definition: FrameManager.hpp:32
    -
    vulk::FrameManager::update
    void update() noexcept
    Definition: FrameManager.cpp:30
    -
    vulk::FrameManager::OnSecondCallback
    std::function< void(const FrameManager &frameManager)> OnSecondCallback
    Definition: FrameManager.hpp:34
    -
    vulk::FrameManager::getFPS
    auto getFPS() const noexcept
    Definition: FrameManager.hpp:44
    -
    vulk::FrameManager::getDeltaTime
    auto getDeltaTime() const noexcept
    Definition: FrameManager.hpp:43
    -
    vulk::FrameManager::getFramerateCString
    FramerateStringBuffer getFramerateCString() const noexcept
    Definition: FrameManager.cpp:55
    -
    vulk::FrameManager::setOnSecondCallback
    void setOnSecondCallback(const OnSecondCallback &func) noexcept
    Definition: FrameManager.hpp:41
    -
    vulk::FrameManager::FramerateStringBuffer
    std::array< char, 16 > FramerateStringBuffer
    Definition: FrameManager.hpp:35
    -
    vulk::FrameManager::getFramerateString
    std::string getFramerateString() const noexcept
    Definition: FrameManager.cpp:64
    -
    vulk::FrameManager::FrameManager
    FrameManager()
    Definition: FrameManager.cpp:26
    -
    vulk
    Definition: ContextGLFW.hpp:26
    -
    vulk::TimePoint
    decltype(Clock::now()) TimePoint
    Definition: Time.hpp:27
    -
    vulk::Duration
    std::chrono::duration< float > Duration
    Definition: Time.hpp:26
    +
    21
    +
    22#include <array> +
    +
    23#include <chrono> +
    +
    24#include <functional> +
    +
    25#include <optional> +
    +
    26#include <string> +
    +
    27
    +
    28#include "Time.hpp"
    +
    29
    +
    30namespace vulk { +
    +
    34class FrameManager final +
    +
    35{
    +
    36public: +
    +
    40 + using OnSecondCallback + = std::function<void(const FrameManager& + frameManager)>; +
    +
    41
    +
    45 + using FramerateStringBuffer + = std::array<char, 16>; +
    +
    46
    +
    47 FrameManager(); +
    +
    48
    +
    52 void update() + noexcept; +
    +
    53
    +
    58 + void setOnSecondCallback(const + OnSecondCallback& + func) noexcept { m_onSecondCallback = func; } +
    +
    59
    +
    64 + [[nodiscard]] auto getDeltaTime() + const noexcept { return m_deltaTime; } +
    +
    65
    +
    70 + [[nodiscard]] auto getFPS() + const noexcept { return m_framerate; } +
    +
    71
    +
    76 [[nodiscard]] FramerateStringBuffer + getFramerateStringBuffer() + const noexcept; +
    +
    77
    +
    82 [[nodiscard]] std::string getFramerateString() + const noexcept; +
    +
    83
    +
    84private:
    +
    85 Duration + m_duration{}; +
    +
    86 TimePoint + m_lastFrame{}; +
    +
    87 TimePoint + m_lastSecond{}; +
    +
    88
    +
    89 float m_deltaTime{}; +
    +
    90 uint32_t m_framerate{};
    +
    91 uint32_t m_frameCounter{}; +
    +
    92
    +
    93 std::optional<OnSecondCallback> + m_onSecondCallback{std::nullopt}; +
    +
    94};
    +
    95} // namespace vulk +
    +
    96
    +
    97std::ostream& operator<<(std::ostream& os, + const vulk::FrameManager& + frameManager); +
    +
    +
    operator<< +
    +
    std::ostream & operator<<(std::ostream &os, const vulk::FrameManager &frameManager)
    +
    Definition: FrameManager.cpp:69
    +
    +
    +
    Time.hpp
    +
    +
    +
    vulk::FrameManager
    +
    Definition: FrameManager.hpp:35
    +
    +
    +
    vulk::FrameManager::update +
    +
    void update() noexcept
    +
    Definition: FrameManager.cpp:30
    +
    +
    +
    vulk::FrameManager::OnSecondCallback +
    +
    std::function< void(const FrameManager &frameManager)> OnSecondCallback
    +
    Definition: FrameManager.hpp:40
    +
    +
    +
    vulk::FrameManager::getFPS +
    +
    auto getFPS() const noexcept
    +
    Definition: FrameManager.hpp:70
    +
    +
    +
    vulk::FrameManager::getFramerateStringBuffer +
    +
    FramerateStringBuffer getFramerateStringBuffer() const noexcept
    +
    Definition: FrameManager.cpp:55
    +
    +
    +
    vulk::FrameManager::getDeltaTime +
    +
    auto getDeltaTime() const noexcept
    +
    Definition: FrameManager.hpp:64
    +
    +
    +
    vulk::FrameManager::setOnSecondCallback +
    +
    void setOnSecondCallback(const OnSecondCallback &func) noexcept
    +
    Definition: FrameManager.hpp:58
    +
    +
    +
    vulk::FrameManager::FramerateStringBuffer +
    +
    std::array< char, 16 > FramerateStringBuffer
    +
    Definition: FrameManager.hpp:45
    +
    +
    +
    vulk::FrameManager::getFramerateString +
    +
    std::string getFramerateString() const noexcept
    +
    Definition: FrameManager.cpp:64
    +
    +
    +
    vulk::FrameManager::FrameManager +
    +
    FrameManager()
    +
    Definition: FrameManager.cpp:26
    +
    +
    +
    vulk
    +
    Definition: Color.hpp:25
    +
    +
    +
    vulk::TimePoint
    +
    decltype(Clock::now()) TimePoint
    +
    Definition: Time.hpp:38
    +
    +
    +
    vulk::Duration
    +
    std::chrono::duration< float > Duration
    +
    Definition: Time.hpp:33
    +
    diff --git a/documentation/html/_keyboard_8hpp_source.html b/documentation/html/_keyboard_8hpp_source.html index 8a86af7..9dffe1f 100644 --- a/documentation/html/_keyboard_8hpp_source.html +++ b/documentation/html/_keyboard_8hpp_source.html @@ -63,181 +63,680 @@
    15 * as being the original software.
    16 *
    17 * 3. This notice may not be removed or altered from any source distribution.
    -
    18 */
    -
    19
    -
    20#pragma once
    -
    21
    -
    22#include <GLFW/glfw3.h>
    -
    23
    -
    24#include <array>
    -
    25#include <functional>
    -
    26
    -
    27namespace vulk {
    -
    28
    -
    29enum class Key
    -
    30{
    -
    31 UNKNOWN = GLFW_KEY_UNKNOWN,
    -
    32
    -
    33 /* Printable keys */
    -
    34 SPACE = GLFW_KEY_SPACE,
    -
    35 APOSTROPHE = GLFW_KEY_APOSTROPHE,
    -
    36 COMMA = GLFW_KEY_COMMA,
    -
    37 MINUS = GLFW_KEY_MINUS,
    -
    38 PERIOD = GLFW_KEY_PERIOD,
    -
    39 SLASH = GLFW_KEY_SLASH,
    -
    40 NUM_0 = GLFW_KEY_0,
    -
    41 NUM_1 = GLFW_KEY_1,
    -
    42 NUM_2 = GLFW_KEY_2,
    -
    43 NUM_3 = GLFW_KEY_3,
    -
    44 NUM_4 = GLFW_KEY_4,
    -
    45 NUM_5 = GLFW_KEY_5,
    -
    46 NUM_6 = GLFW_KEY_6,
    -
    47 NUM_7 = GLFW_KEY_7,
    -
    48 NUM_8 = GLFW_KEY_8,
    -
    49 NUM_9 = GLFW_KEY_9,
    -
    50 SEMICOLON = GLFW_KEY_SEMICOLON,
    -
    51 EQUAL = GLFW_KEY_EQUAL,
    -
    52 A = GLFW_KEY_A,
    -
    53 B = GLFW_KEY_B,
    -
    54 C = GLFW_KEY_C,
    -
    55 D = GLFW_KEY_D,
    -
    56 E = GLFW_KEY_E,
    -
    57 F = GLFW_KEY_F,
    -
    58 G = GLFW_KEY_G,
    -
    59 H = GLFW_KEY_H,
    -
    60 I = GLFW_KEY_I,
    -
    61 J = GLFW_KEY_J,
    -
    62 K = GLFW_KEY_K,
    -
    63 L = GLFW_KEY_L,
    -
    64 M = GLFW_KEY_M,
    -
    65 N = GLFW_KEY_N,
    -
    66 O = GLFW_KEY_O,
    -
    67 P = GLFW_KEY_P,
    -
    68 Q = GLFW_KEY_Q,
    -
    69 R = GLFW_KEY_R,
    -
    70 S = GLFW_KEY_S,
    -
    71 T = GLFW_KEY_T,
    -
    72 U = GLFW_KEY_U,
    -
    73 V = GLFW_KEY_V,
    -
    74 W = GLFW_KEY_W,
    -
    75 X = GLFW_KEY_X,
    -
    76 Y = GLFW_KEY_Y,
    -
    77 Z = GLFW_KEY_Z,
    -
    78 LEFT_BRACKET = GLFW_KEY_LEFT_BRACKET,
    -
    79 BACKSLASH = GLFW_KEY_BACKSLASH,
    -
    80 RIGHT_BRACKET = GLFW_KEY_RIGHT_BRACKET,
    -
    81 GRAVE_ACCENT = GLFW_KEY_GRAVE_ACCENT,
    -
    82 WORLD_1 = GLFW_KEY_WORLD_1,
    -
    83 WORLD_2 = GLFW_KEY_WORLD_2,
    -
    84
    -
    85 /* Function keys */
    -
    86 ESCAPE = GLFW_KEY_ESCAPE,
    -
    87 ENTER = GLFW_KEY_ENTER,
    -
    88 TAB = GLFW_KEY_TAB,
    -
    89 BACKSPACE = GLFW_KEY_BACKSPACE,
    -
    90 INSERT = GLFW_KEY_INSERT,
    -
    91 KEY_DELETE = GLFW_KEY_DELETE,
    -
    92 RIGHT = GLFW_KEY_RIGHT,
    -
    93 LEFT = GLFW_KEY_LEFT,
    -
    94 DOWN = GLFW_KEY_DOWN,
    -
    95 UP = GLFW_KEY_UP,
    -
    96 PAGE_UP = GLFW_KEY_PAGE_UP,
    -
    97 PAGE_DOWN = GLFW_KEY_PAGE_DOWN,
    -
    98 HOME = GLFW_KEY_HOME,
    -
    99 END = GLFW_KEY_END,
    -
    100 CAPS_LOCK = GLFW_KEY_CAPS_LOCK,
    -
    101 SCROLL_LOCK = GLFW_KEY_SCROLL_LOCK,
    -
    102 NUM_LOCK = GLFW_KEY_NUM_LOCK,
    -
    103 PRINT_SCREEN = GLFW_KEY_PRINT_SCREEN,
    -
    104 PAUSE = GLFW_KEY_PAUSE,
    -
    105 F1 = GLFW_KEY_F1,
    -
    106 F2 = GLFW_KEY_F2,
    -
    107 F3 = GLFW_KEY_F3,
    -
    108 F4 = GLFW_KEY_F4,
    -
    109 F5 = GLFW_KEY_F5,
    -
    110 F6 = GLFW_KEY_F6,
    -
    111 F7 = GLFW_KEY_F7,
    -
    112 F8 = GLFW_KEY_F8,
    -
    113 F9 = GLFW_KEY_F9,
    -
    114 F10 = GLFW_KEY_F10,
    -
    115 F11 = GLFW_KEY_F11,
    -
    116 F12 = GLFW_KEY_F12,
    -
    117 F13 = GLFW_KEY_F13,
    -
    118 F14 = GLFW_KEY_F14,
    -
    119 F15 = GLFW_KEY_F15,
    -
    120 F16 = GLFW_KEY_F16,
    -
    121 F17 = GLFW_KEY_F17,
    -
    122 F18 = GLFW_KEY_F18,
    -
    123 F19 = GLFW_KEY_F19,
    -
    124 F20 = GLFW_KEY_F20,
    -
    125 F21 = GLFW_KEY_F21,
    -
    126 F22 = GLFW_KEY_F22,
    -
    127 F23 = GLFW_KEY_F23,
    -
    128 F24 = GLFW_KEY_F24,
    -
    129 F25 = GLFW_KEY_F25,
    -
    130 KP_0 = GLFW_KEY_KP_0,
    -
    131 KP_1 = GLFW_KEY_KP_1,
    -
    132 KP_2 = GLFW_KEY_KP_2,
    -
    133 KP_3 = GLFW_KEY_KP_3,
    -
    134 KP_4 = GLFW_KEY_KP_4,
    -
    135 KP_5 = GLFW_KEY_KP_5,
    -
    136 KP_6 = GLFW_KEY_KP_6,
    -
    137 KP_7 = GLFW_KEY_KP_7,
    -
    138 KP_8 = GLFW_KEY_KP_8,
    -
    139 KP_9 = GLFW_KEY_KP_9,
    -
    140 KP_DECIMAL = GLFW_KEY_KP_DECIMAL,
    -
    141 KP_DIVIDE = GLFW_KEY_KP_DIVIDE,
    -
    142 KP_MULTIPLY = GLFW_KEY_KP_MULTIPLY,
    -
    143 KP_SUBTRACT = GLFW_KEY_KP_SUBTRACT,
    -
    144 KP_ADD = GLFW_KEY_KP_ADD,
    -
    145 KP_ENTER = GLFW_KEY_KP_ENTER,
    -
    146 KP_EQUAL = GLFW_KEY_KP_EQUAL,
    -
    147 LEFT_SHIFT = GLFW_KEY_LEFT_SHIFT,
    -
    148 LEFT_CONTROL = GLFW_KEY_LEFT_CONTROL,
    -
    149 LEFT_ALT = GLFW_KEY_LEFT_ALT,
    -
    150 LEFT_SUPER = GLFW_KEY_LEFT_SUPER,
    -
    151 RIGHT_SHIFT = GLFW_KEY_RIGHT_SHIFT,
    -
    152 RIGHT_CONTROL = GLFW_KEY_RIGHT_CONTROL,
    -
    153 RIGHT_ALT = GLFW_KEY_RIGHT_ALT,
    -
    154 RIGHT_SUPER = GLFW_KEY_RIGHT_SUPER,
    -
    155 MENU = GLFW_KEY_MENU,
    -
    156};
    -
    157
    -
    158class Keyboard final
    -
    159{
    -
    160public:
    -
    166 explicit Keyboard(GLFWwindow* window);
    -
    171 ~Keyboard();
    -
    172
    -
    180 inline bool isKeyDown(vulk::Key key) const noexcept { return m_keyboardInputs[static_cast<size_t>(key)]; };
    -
    181
    -
    188 void onKeyPressed(int scancode, int action);
    -
    189
    -
    196 [[nodiscard]] inline static Keyboard* getKeyboard(GLFWwindow* window) { return s_linkedKeyboard[window]; }
    -
    197
    -
    198private:
    -
    203 static std::unordered_map<GLFWwindow*, Keyboard*> s_linkedKeyboard;
    -
    208 std::array<bool, GLFW_KEY_LAST + 1> m_keyboardInputs{};
    -
    209};
    -
    210} // namespace vulk
    -
    vulk::Keyboard
    Definition: Keyboard.hpp:159
    -
    vulk::Keyboard::Keyboard
    Keyboard(GLFWwindow *window)
    Construct a new Keyboard object.
    Definition: Keyboard.cpp:27
    -
    vulk::Keyboard::getKeyboard
    static Keyboard * getKeyboard(GLFWwindow *window)
    Get the Keyboard object.
    Definition: Keyboard.hpp:196
    -
    vulk::Keyboard::~Keyboard
    ~Keyboard()
    Destroy the Keyboard object.
    Definition: Keyboard.cpp:33
    -
    vulk::Keyboard::onKeyPressed
    void onKeyPressed(int scancode, int action)
    Definition: Keyboard.cpp:37
    -
    vulk::Keyboard::isKeyDown
    bool isKeyDown(vulk::Key key) const noexcept
    Definition: Keyboard.hpp:180
    -
    vulk
    Definition: ContextGLFW.hpp:26
    -
    vulk::Key
    Key
    Definition: Keyboard.hpp:30
    - - - - - - - - - - +
    18 */ +
    +
    19
    +
    20#pragma once +
    +
    21
    +
    22#include <GLFW/glfw3.h> +
    +
    23
    +
    24#include <array> +
    +
    25#include <functional> +
    +
    26
    +
    27namespace vulk { +
    +
    31enum class Key +
    +
    32{
    +
    33 UNKNOWN + = GLFW_KEY_UNKNOWN, +
    +
    34
    +
    35 /* Printable keys */ +
    +
    36 SPACE + = GLFW_KEY_SPACE, +
    +
    37 APOSTROPHE + = GLFW_KEY_APOSTROPHE, +
    +
    38 COMMA + = GLFW_KEY_COMMA, +
    +
    39 MINUS + = GLFW_KEY_MINUS, +
    +
    40 PERIOD + = GLFW_KEY_PERIOD, +
    +
    41 SLASH + = GLFW_KEY_SLASH, +
    +
    42 NUM_0 + = GLFW_KEY_0, +
    +
    43 NUM_1 + = GLFW_KEY_1, +
    +
    44 NUM_2 + = GLFW_KEY_2, +
    +
    45 NUM_3 + = GLFW_KEY_3, +
    +
    46 NUM_4 + = GLFW_KEY_4, +
    +
    47 NUM_5 + = GLFW_KEY_5, +
    +
    48 NUM_6 + = GLFW_KEY_6, +
    +
    49 NUM_7 + = GLFW_KEY_7, +
    +
    50 NUM_8 + = GLFW_KEY_8, +
    +
    51 NUM_9 + = GLFW_KEY_9, +
    +
    52 SEMICOLON + = GLFW_KEY_SEMICOLON, +
    +
    53 EQUAL + = GLFW_KEY_EQUAL, +
    +
    54 A + = GLFW_KEY_A, +
    +
    55 B + = GLFW_KEY_B, +
    +
    56 C + = GLFW_KEY_C, +
    +
    57 D + = GLFW_KEY_D, +
    +
    58 E + = GLFW_KEY_E, +
    +
    59 F + = GLFW_KEY_F, +
    +
    60 G + = GLFW_KEY_G, +
    +
    61 H + = GLFW_KEY_H, +
    +
    62 I + = GLFW_KEY_I, +
    +
    63 J + = GLFW_KEY_J, +
    +
    64 K + = GLFW_KEY_K, +
    +
    65 L + = GLFW_KEY_L, +
    +
    66 M + = GLFW_KEY_M, +
    +
    67 N + = GLFW_KEY_N, +
    +
    68 O + = GLFW_KEY_O, +
    +
    69 P + = GLFW_KEY_P, +
    +
    70 Q + = GLFW_KEY_Q, +
    +
    71 R + = GLFW_KEY_R, +
    +
    72 S + = GLFW_KEY_S, +
    +
    73 T + = GLFW_KEY_T, +
    +
    74 U + = GLFW_KEY_U, +
    +
    75 V + = GLFW_KEY_V, +
    +
    76 W + = GLFW_KEY_W, +
    +
    77 X + = GLFW_KEY_X, +
    +
    78 Y + = GLFW_KEY_Y, +
    +
    79 Z + = GLFW_KEY_Z, +
    +
    80 LEFT_BRACKET + = GLFW_KEY_LEFT_BRACKET, +
    +
    81 BACKSLASH + = GLFW_KEY_BACKSLASH, +
    +
    82 RIGHT_BRACKET + = GLFW_KEY_RIGHT_BRACKET, +
    +
    83 GRAVE_ACCENT + = GLFW_KEY_GRAVE_ACCENT, +
    +
    84 WORLD_1 + = GLFW_KEY_WORLD_1, +
    +
    85 WORLD_2 + = GLFW_KEY_WORLD_2, +
    +
    86
    +
    87 /* Function keys */ +
    +
    88 ESCAPE + = GLFW_KEY_ESCAPE, +
    +
    89 ENTER + = GLFW_KEY_ENTER, +
    +
    90 TAB + = GLFW_KEY_TAB, +
    +
    91 BACKSPACE + = GLFW_KEY_BACKSPACE, +
    +
    92 INSERT + = GLFW_KEY_INSERT, +
    +
    93 KEY_DELETE + = GLFW_KEY_DELETE, +
    +
    94 RIGHT + = GLFW_KEY_RIGHT, +
    +
    95 LEFT + = GLFW_KEY_LEFT, +
    +
    96 DOWN + = GLFW_KEY_DOWN, +
    +
    97 UP + = GLFW_KEY_UP, +
    +
    98 PAGE_UP + = GLFW_KEY_PAGE_UP, +
    +
    99 PAGE_DOWN + = GLFW_KEY_PAGE_DOWN, +
    +
    100 HOME + = GLFW_KEY_HOME, +
    +
    101 END + = GLFW_KEY_END, +
    +
    102 CAPS_LOCK + = GLFW_KEY_CAPS_LOCK, +
    +
    103 SCROLL_LOCK + = GLFW_KEY_SCROLL_LOCK, +
    +
    104 NUM_LOCK + = GLFW_KEY_NUM_LOCK, +
    +
    105 PRINT_SCREEN + = GLFW_KEY_PRINT_SCREEN, +
    +
    106 PAUSE + = GLFW_KEY_PAUSE, +
    +
    107 F1 + = GLFW_KEY_F1, +
    +
    108 F2 + = GLFW_KEY_F2, +
    +
    109 F3 + = GLFW_KEY_F3, +
    +
    110 F4 + = GLFW_KEY_F4, +
    +
    111 F5 + = GLFW_KEY_F5, +
    +
    112 F6 + = GLFW_KEY_F6, +
    +
    113 F7 + = GLFW_KEY_F7, +
    +
    114 F8 + = GLFW_KEY_F8, +
    +
    115 F9 + = GLFW_KEY_F9, +
    +
    116 F10 + = GLFW_KEY_F10, +
    +
    117 F11 + = GLFW_KEY_F11, +
    +
    118 F12 + = GLFW_KEY_F12, +
    +
    119 F13 + = GLFW_KEY_F13, +
    +
    120 F14 + = GLFW_KEY_F14, +
    +
    121 F15 + = GLFW_KEY_F15, +
    +
    122 F16 + = GLFW_KEY_F16, +
    +
    123 F17 + = GLFW_KEY_F17, +
    +
    124 F18 + = GLFW_KEY_F18, +
    +
    125 F19 + = GLFW_KEY_F19, +
    +
    126 F20 + = GLFW_KEY_F20, +
    +
    127 F21 + = GLFW_KEY_F21, +
    +
    128 F22 + = GLFW_KEY_F22, +
    +
    129 F23 + = GLFW_KEY_F23, +
    +
    130 F24 + = GLFW_KEY_F24, +
    +
    131 F25 + = GLFW_KEY_F25, +
    +
    132 KP_0 + = GLFW_KEY_KP_0, +
    +
    133 KP_1 + = GLFW_KEY_KP_1, +
    +
    134 KP_2 + = GLFW_KEY_KP_2, +
    +
    135 KP_3 + = GLFW_KEY_KP_3, +
    +
    136 KP_4 + = GLFW_KEY_KP_4, +
    +
    137 KP_5 + = GLFW_KEY_KP_5, +
    +
    138 KP_6 + = GLFW_KEY_KP_6, +
    +
    139 KP_7 + = GLFW_KEY_KP_7, +
    +
    140 KP_8 + = GLFW_KEY_KP_8, +
    +
    141 KP_9 + = GLFW_KEY_KP_9, +
    +
    142 KP_DECIMAL + = GLFW_KEY_KP_DECIMAL, +
    +
    143 KP_DIVIDE + = GLFW_KEY_KP_DIVIDE, +
    +
    144 KP_MULTIPLY + = GLFW_KEY_KP_MULTIPLY, +
    +
    145 KP_SUBTRACT + = GLFW_KEY_KP_SUBTRACT, +
    +
    146 KP_ADD + = GLFW_KEY_KP_ADD, +
    +
    147 KP_ENTER + = GLFW_KEY_KP_ENTER, +
    +
    148 KP_EQUAL + = GLFW_KEY_KP_EQUAL, +
    +
    149 LEFT_SHIFT + = GLFW_KEY_LEFT_SHIFT, +
    +
    150 LEFT_CONTROL + = GLFW_KEY_LEFT_CONTROL, +
    +
    151 LEFT_ALT + = GLFW_KEY_LEFT_ALT, +
    +
    152 LEFT_SUPER + = GLFW_KEY_LEFT_SUPER, +
    +
    153 RIGHT_SHIFT + = GLFW_KEY_RIGHT_SHIFT, +
    +
    154 RIGHT_CONTROL + = GLFW_KEY_RIGHT_CONTROL, +
    +
    155 RIGHT_ALT + = GLFW_KEY_RIGHT_ALT, +
    +
    156 RIGHT_SUPER + = GLFW_KEY_RIGHT_SUPER, +
    +
    157 MENU + = GLFW_KEY_MENU, +
    +
    158};
    +
    159
    +
    163class Keyboard final +
    +
    164{
    +
    165public: +
    +
    171 explicit Keyboard(GLFWwindow* + window); +
    +
    176 ~Keyboard(); +
    +
    177
    +
    185 + inline bool isKeyDown(vulk::Key + key) const noexcept { return m_keyboardInputs[static_cast<size_t>(key)]; }; +
    +
    186
    +
    193 void onKeyPressed(int scancode, int action); +
    +
    194
    +
    201 + [[nodiscard]] inline static Keyboard* + getKeyboard(GLFWwindow* + window) { return s_linkedKeyboard[window]; } +
    +
    202
    +
    203private: +
    +
    208 static std::unordered_map<GLFWwindow*, Keyboard*> s_linkedKeyboard; +
    +
    213 std::array<bool, + GLFW_KEY_LAST + 1> m_keyboardInputs{}; +
    +
    214};
    +
    215} // namespace vulk +
    +
    +
    vulk::Keyboard
    +
    Definition: Keyboard.hpp:164
    +
    +
    +
    vulk::Keyboard::Keyboard +
    +
    Keyboard(GLFWwindow *window)
    +
    Construct a new Keyboard object.
    +
    Definition: Keyboard.cpp:27
    +
    +
    +
    vulk::Keyboard::getKeyboard +
    +
    static Keyboard * getKeyboard(GLFWwindow *window)
    +
    Get the Keyboard object.
    +
    Definition: Keyboard.hpp:201
    +
    +
    +
    vulk::Keyboard::~Keyboard +
    +
    ~Keyboard()
    +
    Destroy the Keyboard object.
    +
    Definition: Keyboard.cpp:33
    +
    +
    +
    vulk::Keyboard::onKeyPressed +
    +
    void onKeyPressed(int scancode, int action)
    +
    Definition: Keyboard.cpp:37
    +
    +
    +
    vulk::Keyboard::isKeyDown +
    +
    bool isKeyDown(vulk::Key key) const noexcept
    +
    Definition: Keyboard.hpp:185
    +
    +
    +
    vulk
    +
    Definition: Color.hpp:25
    +
    +
    +
    vulk::Key
    +
    Key
    +
    Definition: Keyboard.hpp:32
    +
    +
    +
    vulk::Key::RIGHT_ALT +
    +
    @ RIGHT_ALT
    +
    +
    +
    vulk::Key::X +
    +
    @ X
    +
    +
    +
    vulk::Key::NUM_5 +
    +
    @ NUM_5
    +
    +
    +
    vulk::Key::NUM_0 +
    +
    @ NUM_0
    +
    +
    +
    vulk::Key::LEFT_BRACKET +
    +
    @ LEFT_BRACKET
    +
    +
    +
    vulk::Key::C +
    +
    @ C
    +
    +
    +
    vulk::Key::GRAVE_ACCENT +
    +
    @ GRAVE_ACCENT
    +
    +
    +
    vulk::Key::KP_SUBTRACT +
    +
    @ KP_SUBTRACT
    +
    +
    +
    vulk::Key::KP_DECIMAL +
    +
    @ KP_DECIMAL
    +
    +
    +
    vulk::Key::WORLD_1 +
    +
    @ WORLD_1
    +
    diff --git a/documentation/html/_mat3_8hpp.html b/documentation/html/_mat3_8hpp.html index 1cb66b6..ff75f58 100644 --- a/documentation/html/_mat3_8hpp.html +++ b/documentation/html/_mat3_8hpp.html @@ -60,6 +60,13 @@

    Classes

    struct  vulk::Mat3< T > + +   + The Mat3 + structure that can be use for mathematical purpose. More...
    + +   + + + +

    diff --git a/documentation/html/_mat3_8hpp_source.html b/documentation/html/_mat3_8hpp_source.html index 8796dc5..4a09875 100644 --- a/documentation/html/_mat3_8hpp_source.html +++ b/documentation/html/_mat3_8hpp_source.html @@ -66,75 +66,230 @@
    18 */
    19
    20#pragma once
    -
    21
    -
    22#include <glm/glm.hpp>
    -
    23#include <glm/gtx/string_cast.hpp>
    -
    24
    -
    25#include <array>
    -
    26#include <cmath>
    -
    27#include <iostream>
    -
    28
    -
    29namespace vulk {
    -
    30template<typename T>
    -
    31struct Mat3
    -
    32{
    -
    33 std::array<T, 9> m{
    -
    34 1.0, 0.0, 0.0, // a b c
    -
    35 0.0, 1.0, 0.0, // d e f
    -
    36 0.0, 0.0, 1.0 // g h i
    -
    37 };
    -
    38
    -
    43 constexpr Mat3() = default;
    -
    48 constexpr explicit Mat3(T value) : m{std::array<T, 9>{value, 0.0, 0.0, 0.0, value, 0.0, 0.0, 0.0, value}} {}
    -
    53 constexpr explicit Mat3(const std::array<T, 9> mat) : m{mat} {}
    -
    58 constexpr Mat3(T a1, T a2, T a3, T a4, T a5, T a6, T a7, T a8, T a9)
    -
    59 : m{std::array<T, 9>{a1, a2, a3, a4, a5, a6, a7, a8, a9}}
    -
    60 {
    -
    61 }
    -
    62
    -
    68 constexpr Mat3 inverse() const noexcept
    -
    69 {
    -
    70 auto cfMatrix = coFactor();
    -
    71 auto d = determinant();
    -
    72
    -
    73 return Mat3{cfMatrix.m[0] / d, cfMatrix.m[1] / d, cfMatrix.m[2] / d, cfMatrix.m[3] / d, cfMatrix.m[4] / d,
    -
    74 cfMatrix.m[5] / d, cfMatrix.m[6] / d, cfMatrix.m[7] / d, cfMatrix.m[8] / d};
    -
    75 }
    -
    76
    -
    82 constexpr Mat3 coFactor() const noexcept
    -
    83 {
    -
    84 return Mat3{
    -
    85 ((m[4] * m[8]) - (m[5] * m[7])), -((m[3] * m[8]) - (m[5] * m[6])), ((m[3] * m[7]) - (m[4] * m[6])),
    -
    86 -((m[1] * m[8]) - (m[2] * m[7])), ((m[0] * m[8]) - (m[2] * m[6])), -((m[0] * m[7]) - (m[1] * m[6])),
    -
    87 ((m[1] * m[5]) - (m[2] * m[4])), -((m[0] * m[5]) - (m[2] * m[3])), ((m[0] * m[4]) - (m[1] * m[3]))};
    -
    88 }
    -
    89
    -
    95 constexpr T determinant() const noexcept
    -
    96 {
    -
    97 auto cfMatrix = coFactor();
    -
    98 return ((m[0] * cfMatrix.m[0]) + (m[1] * cfMatrix.m[1]) + (m[2] * cfMatrix.m[2]));
    -
    99 }
    -
    100
    -
    108 constexpr friend std::ostream& operator<<(std::ostream& os, const Mat3& mat3) noexcept
    -
    109 {
    -
    110 return os << mat3.m[0] << ' ' << mat3.m[1] << ' ' << mat3.m[2] << '\n'
    -
    111 << mat3.m[3] << ' ' << mat3.m[4] << ' ' << mat3.m[5] << '\n'
    -
    112 << mat3.m[6] << ' ' << mat3.m[7] << ' ' << mat3.m[8];
    -
    113 }
    -
    114};
    -
    115} // namespace vulk
    -
    vulk
    Definition: ContextGLFW.hpp:26
    - -
    vulk::Mat3
    Definition: Mat3.hpp:32
    -
    vulk::Mat3::coFactor
    constexpr Mat3 coFactor() const noexcept
    Definition: Mat3.hpp:82
    -
    vulk::Mat3::determinant
    constexpr T determinant() const noexcept
    Definition: Mat3.hpp:95
    -
    vulk::Mat3::Mat3
    constexpr Mat3()=default
    -
    vulk::Mat3::inverse
    constexpr Mat3 inverse() const noexcept
    Definition: Mat3.hpp:68
    -
    vulk::Mat3::operator<<
    constexpr friend std::ostream & operator<<(std::ostream &os, const Mat3 &mat3) noexcept
    Definition: Mat3.hpp:108
    -
    vulk::Mat3::Mat3
    constexpr Mat3(const std::array< T, 9 > mat)
    Definition: Mat3.hpp:53
    -
    vulk::Mat3::m
    std::array< T, 9 > m
    Definition: Mat3.hpp:33
    -
    vulk::Mat3::Mat3
    constexpr Mat3(T a1, T a2, T a3, T a4, T a5, T a6, T a7, T a8, T a9)
    Definition: Mat3.hpp:58
    -
    vulk::Mat3::Mat3
    constexpr Mat3(T value)
    Definition: Mat3.hpp:48
    +
    21
    +
    22#include <glm/glm.hpp> +
    +
    23#include <glm/gtx/string_cast.hpp> +
    +
    24
    +
    25#include <array> +
    +
    26#include <cmath> +
    +
    27#include <iostream> +
    +
    28
    +
    29namespace vulk { +
    +
    30template<typename T> +
    +
    35struct Mat3
    +
    36{
    +
    37 + std::array<T, 9> m{ +
    +
    38 1.0, 0.0, 0.0, // a b c
    +
    39 0.0, 1.0, 0.0, // d e f
    +
    40 0.0, 0.0, 1.0 // g h i
    +
    41 };
    +
    42
    +
    47 + constexpr Mat3() + = default; +
    +
    52 + constexpr explicit Mat3(T + value) : m{std::array<T, 9>{value, + 0.0, 0.0, 0.0, value, 0.0, 0.0, 0.0, value}} {} +
    +
    57 + constexpr explicit Mat3(const std::array<T, 9> mat) : m{mat} {} +
    +
    62 + constexpr Mat3(T + a1, T a2, T a3, T a4, T a5, T a6, T a7, T a8, T a9) +
    +
    63 : m{std::array<T, 9>{a1, + a2, a3, a4, a5, a6, a7, a8, a9}} +
    +
    64 {
    +
    65 }
    +
    66
    +
    72 + constexpr Mat3 inverse() + const noexcept +
    +
    73 {
    +
    74 auto cfMatrix = coFactor(); +
    +
    75 auto d = determinant(); +
    +
    76
    +
    77 return + Mat3{cfMatrix.m[0] + / d, cfMatrix.m[1] / d, cfMatrix.m[2] / d, cfMatrix.m[3] / d, cfMatrix.m[4] / d, +
    +
    78 cfMatrix.m[5] / d, + cfMatrix.m[6] / d, cfMatrix.m[7] / d, cfMatrix.m[8] / d}; +
    +
    79 }
    +
    80
    +
    86 + constexpr Mat3 coFactor() + const noexcept +
    +
    87 {
    +
    88 return + Mat3{ +
    +
    89 ((m[4] * m[8]) - (m[5] * + m[7])), -((m[3] * m[8]) - (m[5] * m[6])), ((m[3] * m[7]) - (m[4] * m[6])), +
    +
    90 -((m[1] * m[8]) - (m[2] * + m[7])), ((m[0] * m[8]) - (m[2] * m[6])), -((m[0] * m[7]) - (m[1] * m[6])), +
    +
    91 ((m[1] * m[5]) - (m[2] * + m[4])), -((m[0] * m[5]) - (m[2] * m[3])), ((m[0] * m[4]) - (m[1] * m[3]))}; +
    +
    92 }
    +
    93
    +
    99 + constexpr T + determinant() + const noexcept +
    +
    100 {
    +
    101 auto cfMatrix = coFactor(); +
    +
    102 return + ((m[0] * cfMatrix.m[0]) + (m[1] * cfMatrix.m[1]) + (m[2] * cfMatrix.m[2])); +
    +
    103 }
    +
    104
    +
    112 + constexpr friend std::ostream& operator<<(std::ostream& + os, const Mat3& + mat3) noexcept
    +
    113 {
    +
    114 return + os << mat3.m[0] << ' ' << mat3.m[1] << ' ' << mat3.m[2] << '\n' +
    +
    115 << mat3.m[3] << + ' ' << mat3.m[4] << ' ' << mat3.m[5] << '\n' +
    +
    116 << mat3.m[6] << + ' ' << mat3.m[7] << ' ' << mat3.m[8]; +
    +
    117 }
    +
    118};
    +
    119} // namespace vulk +
    +
    +
    vulk
    +
    Definition: Color.hpp:25
    +
    +
    +
    vulk::Key::T +
    +
    @ T
    +
    +
    +
    vulk::Mat3
    +
    The Mat3 structure that can be use for mathematical purpose.
    +
    Definition: Mat3.hpp:36
    +
    +
    +
    vulk::Mat3::coFactor
    +
    constexpr Mat3 coFactor() const noexcept
    +
    Definition: Mat3.hpp:86
    +
    +
    +
    vulk::Mat3::determinant
    +
    constexpr T determinant() const noexcept
    +
    Definition: Mat3.hpp:99
    +
    +
    +
    vulk::Mat3::Mat3 +
    +
    constexpr Mat3()=default
    +
    +
    +
    vulk::Mat3::inverse +
    +
    constexpr Mat3 inverse() const noexcept
    +
    Definition: Mat3.hpp:72
    +
    +
    +
    vulk::Mat3::operator<< +
    +
    constexpr friend std::ostream & operator<<(std::ostream &os, const Mat3 &mat3) + noexcept +
    +
    Definition: Mat3.hpp:112
    +
    +
    +
    vulk::Mat3::Mat3 +
    +
    constexpr Mat3(const std::array< T, 9 > mat)
    +
    Definition: Mat3.hpp:57
    +
    +
    +
    vulk::Mat3::m
    +
    std::array< T, 9 > m
    +
    Definition: Mat3.hpp:37
    +
    +
    +
    vulk::Mat3::Mat3 +
    +
    constexpr Mat3(T a1, T a2, T a3, T a4, T a5, T a6, T a7, T a8, T a9)
    +
    Definition: Mat3.hpp:62
    +
    +
    +
    vulk::Mat3::Mat3 +
    +
    constexpr Mat3(T value)
    +
    Definition: Mat3.hpp:52
    +
    diff --git a/documentation/html/_mouse_8hpp_source.html b/documentation/html/_mouse_8hpp_source.html index 55f9097..e548f16 100644 --- a/documentation/html/_mouse_8hpp_source.html +++ b/documentation/html/_mouse_8hpp_source.html @@ -64,67 +64,235 @@
    16 *
    17 * 3. This notice may not be removed or altered from any source distribution.
    18 */
    -
    19
    -
    20#pragma once
    -
    21
    -
    22#include <GLFW/glfw3.h>
    -
    23
    -
    24#include <array>
    -
    25#include <functional>
    -
    26
    -
    27namespace vulk {
    -
    28
    -
    29enum class Buttons
    -
    30{
    -
    31 BUTTON_1 = GLFW_MOUSE_BUTTON_1,
    -
    32 BUTTON_2 = GLFW_MOUSE_BUTTON_2,
    -
    33 BUTTON_3 = GLFW_MOUSE_BUTTON_3,
    -
    34 BUTTON_4 = GLFW_MOUSE_BUTTON_4,
    -
    35 BUTTON_5 = GLFW_MOUSE_BUTTON_5,
    -
    36 BUTTON_6 = GLFW_MOUSE_BUTTON_6,
    -
    37 BUTTON_7 = GLFW_MOUSE_BUTTON_7,
    -
    38 BUTTON_8 = GLFW_MOUSE_BUTTON_8,
    -
    39 BUTTON_LEFT = GLFW_MOUSE_BUTTON_LEFT,
    -
    40 BUTTON_RIGHT = GLFW_MOUSE_BUTTON_RIGHT,
    -
    41 BUTTON_MIDDLE = GLFW_MOUSE_BUTTON_MIDDLE,
    -
    42 BUTTON_LAST = GLFW_MOUSE_BUTTON_LAST,
    -
    43};
    -
    44
    -
    45class Mouse final
    -
    46{
    -
    47public:
    -
    48 explicit Mouse(GLFWwindow* window);
    -
    49 ~Mouse();
    -
    50
    -
    51 inline bool isButtonDown(vulk::Buttons button) const noexcept { return m_mouseInputs[static_cast<size_t>(button)]; }
    -
    52
    -
    53 void onButtonPressed(int button, int action);
    -
    54
    -
    55 [[nodiscard]] inline static Mouse* getMouse(GLFWwindow* window) { return s_linkedMouse[window]; }
    -
    56
    -
    57private:
    -
    58 static std::unordered_map<GLFWwindow*, Mouse*> s_linkedMouse;
    -
    59 std::array<bool, GLFW_MOUSE_BUTTON_LAST + 1> m_mouseInputs{};
    -
    60};
    -
    61} // namespace vulk
    -
    vulk::Mouse
    Definition: Mouse.hpp:46
    -
    vulk::Mouse::onButtonPressed
    void onButtonPressed(int button, int action)
    Definition: Mouse.cpp:37
    -
    vulk::Mouse::isButtonDown
    bool isButtonDown(vulk::Buttons button) const noexcept
    Definition: Mouse.hpp:51
    -
    vulk::Mouse::Mouse
    Mouse(GLFWwindow *window)
    Definition: Mouse.cpp:27
    -
    vulk::Mouse::getMouse
    static Mouse * getMouse(GLFWwindow *window)
    Definition: Mouse.hpp:55
    -
    vulk::Mouse::~Mouse
    ~Mouse()
    Definition: Mouse.cpp:33
    -
    vulk
    Definition: ContextGLFW.hpp:26
    -
    vulk::Buttons
    Buttons
    Definition: Mouse.hpp:30
    - - - - - - - - - - +
    19
    +
    20#pragma once +
    +
    21
    +
    22#include <GLFW/glfw3.h> +
    +
    23
    +
    24#include <array> +
    +
    25#include <functional> +
    +
    26
    +
    27namespace vulk { +
    +
    28
    +
    32enum class Buttons +
    +
    33{
    +
    34 BUTTON_1 + = GLFW_MOUSE_BUTTON_1, +
    +
    35 BUTTON_2 + = GLFW_MOUSE_BUTTON_2, +
    +
    36 BUTTON_3 + = GLFW_MOUSE_BUTTON_3, +
    +
    37 BUTTON_4 + = GLFW_MOUSE_BUTTON_4, +
    +
    38 BUTTON_5 + = GLFW_MOUSE_BUTTON_5, +
    +
    39 BUTTON_6 + = GLFW_MOUSE_BUTTON_6, +
    +
    40 BUTTON_7 + = GLFW_MOUSE_BUTTON_7, +
    +
    41 BUTTON_8 + = GLFW_MOUSE_BUTTON_8, +
    +
    42 BUTTON_LEFT + = GLFW_MOUSE_BUTTON_LEFT, +
    +
    43 BUTTON_RIGHT + = GLFW_MOUSE_BUTTON_RIGHT, +
    +
    44 BUTTON_MIDDLE + = GLFW_MOUSE_BUTTON_MIDDLE, +
    +
    45 BUTTON_LAST + = GLFW_MOUSE_BUTTON_LAST, +
    +
    46};
    +
    47
    +
    51class Mouse final +
    +
    52{
    +
    53public: +
    +
    54 explicit Mouse(GLFWwindow* + window); +
    +
    55 ~Mouse(); +
    +
    56
    +
    62 + inline bool isButtonDown(vulk::Buttons button) const noexcept { return m_mouseInputs[static_cast<size_t>(button)]; } +
    +
    63
    +
    64 void onButtonPressed(int button, int action); +
    +
    65
    +
    66 + [[nodiscard]] inline static Mouse* + getMouse(GLFWwindow* + window) { return s_linkedMouse[window]; } +
    +
    67
    +
    68private: +
    +
    69 static std::unordered_map<GLFWwindow*, Mouse*> s_linkedMouse; +
    +
    70 std::array<bool, + GLFW_MOUSE_BUTTON_LAST + 1> m_mouseInputs{}; +
    +
    71};
    +
    72} // namespace vulk +
    +
    +
    vulk::Mouse
    +
    Definition: Mouse.hpp:52
    +
    +
    +
    vulk::Mouse::onButtonPressed +
    +
    void onButtonPressed(int button, int action)
    +
    Definition: Mouse.cpp:37
    +
    +
    +
    vulk::Mouse::isButtonDown +
    +
    bool isButtonDown(vulk::Buttons button) const noexcept
    +
    Definition: Mouse.hpp:62
    +
    +
    +
    vulk::Mouse::Mouse +
    +
    Mouse(GLFWwindow *window)
    +
    Definition: Mouse.cpp:27
    +
    +
    +
    vulk::Mouse::getMouse
    +
    static Mouse * getMouse(GLFWwindow *window)
    +
    Definition: Mouse.hpp:66
    +
    +
    +
    vulk::Mouse::~Mouse +
    +
    ~Mouse()
    +
    Definition: Mouse.cpp:33
    +
    +
    +
    vulk
    +
    Definition: Color.hpp:25
    +
    +
    +
    vulk::Buttons
    +
    Buttons
    +
    Definition: Mouse.hpp:33
    +
    +
    +
    vulk::Buttons::BUTTON_MIDDLE +
    +
    @ BUTTON_MIDDLE
    +
    +
    +
    vulk::Buttons::BUTTON_6 +
    +
    @ BUTTON_6
    +
    +
    +
    vulk::Buttons::BUTTON_LEFT +
    +
    @ BUTTON_LEFT
    +
    +
    +
    vulk::Buttons::BUTTON_7 +
    +
    @ BUTTON_7
    +
    +
    +
    vulk::Buttons::BUTTON_8 +
    +
    @ BUTTON_8
    +
    +
    +
    vulk::Buttons::BUTTON_5 +
    +
    @ BUTTON_5
    +
    +
    +
    vulk::Buttons::BUTTON_2 +
    +
    @ BUTTON_2
    +
    +
    +
    vulk::Buttons::BUTTON_3 +
    +
    @ BUTTON_3
    +
    +
    +
    vulk::Buttons::BUTTON_1 +
    +
    @ BUTTON_1
    +
    +
    +
    vulk::Buttons::BUTTON_4 +
    +
    @ BUTTON_4
    +
    diff --git a/documentation/html/_rect_8hpp.html b/documentation/html/_rect_8hpp.html index fdf1536..c6f10ad 100644 --- a/documentation/html/_rect_8hpp.html +++ b/documentation/html/_rect_8hpp.html @@ -59,6 +59,13 @@

    Classes

    struct  vulk::Rect< T >
     The Rect + structure that can be use for mathematical purpose or for setting hitboxes for example. More...
     
    + + + +

    diff --git a/documentation/html/_rect_8hpp_source.html b/documentation/html/_rect_8hpp_source.html index 9b4b480..8d80d1a 100644 --- a/documentation/html/_rect_8hpp_source.html +++ b/documentation/html/_rect_8hpp_source.html @@ -64,85 +64,361 @@
    16 *
    17 * 3. This notice may not be removed or altered from any source distribution.
    18 */
    -
    19
    -
    20#pragma once
    -
    21
    -
    22#include <Vulk/Vec2.hpp>
    -
    23
    -
    24#include <algorithm>
    -
    25#include <ostream>
    -
    26
    -
    27namespace vulk {
    -
    28template<typename T>
    -
    29struct Rect
    -
    30{
    -
    31 T left;
    -
    32 T top;
    -
    33 T width;
    -
    34 T height;
    -
    35
    -
    40 constexpr Rect() = default;
    -
    45 constexpr Rect(T aLeft, T aTop, T aWidth, T aHeight) : left{aLeft}, top{aTop}, width{aWidth}, height{aHeight} {}
    -
    50 constexpr Rect(const Vec2<T>& pos, const Vec2<T>& size) : left{pos.x}, top{pos.y}, width{size.x}, height{size.y} {}
    -
    51
    -
    59 constexpr bool operator==(const Rect<T>& right) const noexcept
    -
    60 {
    -
    61 return left == right.left && top == right.top && width == right.width && height == right.height;
    -
    62 }
    -
    63
    -
    71 constexpr bool operator!=(const Rect<T>& right) const noexcept
    -
    72 {
    -
    73 return left != right.left || top != right.top || width != right.width || height != right.height;
    -
    74 }
    -
    75
    -
    84 [[nodiscard]] constexpr bool contains(T x, T y) const noexcept
    -
    85 {
    -
    86 const T minX = std::min(left, static_cast<T>(left + width));
    -
    87 const T maxX = std::max(left, static_cast<T>(left + width));
    -
    88 const T minY = std::min(top, static_cast<T>(top + height));
    -
    89 const T maxY = std::max(top, static_cast<T>(top + height));
    -
    90
    -
    91 return (x >= minX) && (x <= maxX) && (y >= minY) && (y <= maxY);
    -
    92 }
    -
    93
    -
    101 [[nodiscard]] constexpr bool contains(const Vec2<T>& point) const noexcept
    -
    102 {
    -
    103 const T minX = std::min(left, static_cast<T>(left + width));
    -
    104 const T maxX = std::max(left, static_cast<T>(left + width));
    -
    105 const T minY = std::min(top, static_cast<T>(top + height));
    -
    106 const T maxY = std::max(top, static_cast<T>(top + height));
    -
    107
    -
    108 return (point.x >= minX) && (point.x <= maxX) && (point.y >= minY) && (point.y <= maxY);
    -
    109 }
    -
    110
    -
    118 constexpr friend std::ostream& operator<<(std::ostream& os, const Rect<T>& rect) noexcept
    -
    119 {
    -
    120 return os << rect.left << ' ' << rect.top << ' ' << rect.width << ' ' << rect.height;
    -
    121 }
    -
    122};
    -
    123
    -
    124using Rectf = Rect<float>;
    -
    125using Rectd = Rect<double>;
    -
    126using Recti = Rect<int>;
    -
    127using Rectu = Rect<unsigned int>;
    -
    128} // namespace vulk
    - -
    vulk
    Definition: ContextGLFW.hpp:26
    - -
    vulk::Rect
    Definition: Rect.hpp:30
    -
    vulk::Rect::contains
    constexpr bool contains(T x, T y) const noexcept
    Definition: Rect.hpp:84
    -
    vulk::Rect::left
    T left
    Definition: Rect.hpp:31
    -
    vulk::Rect::operator!=
    constexpr bool operator!=(const Rect< T > &right) const noexcept
    Definition: Rect.hpp:71
    -
    vulk::Rect::Rect
    constexpr Rect()=default
    -
    vulk::Rect::operator<<
    constexpr friend std::ostream & operator<<(std::ostream &os, const Rect< T > &rect) noexcept
    Definition: Rect.hpp:118
    -
    vulk::Rect::contains
    constexpr bool contains(const Vec2< T > &point) const noexcept
    Definition: Rect.hpp:101
    -
    vulk::Rect::operator==
    constexpr bool operator==(const Rect< T > &right) const noexcept
    Definition: Rect.hpp:59
    -
    vulk::Rect::Rect
    constexpr Rect(T aLeft, T aTop, T aWidth, T aHeight)
    Definition: Rect.hpp:45
    -
    vulk::Rect::height
    T height
    Definition: Rect.hpp:34
    -
    vulk::Rect::top
    T top
    Definition: Rect.hpp:32
    -
    vulk::Rect::width
    T width
    Definition: Rect.hpp:33
    -
    vulk::Rect::Rect
    constexpr Rect(const Vec2< T > &pos, const Vec2< T > &size)
    Definition: Rect.hpp:50
    -
    vulk::Vec2
    Definition: Vec2.hpp:28
    +
    19
    +
    20#pragma once +
    +
    21
    +
    22#include <Vulk/Vec2.hpp>
    +
    23
    +
    24#include <algorithm> +
    +
    25#include <ostream> +
    +
    26
    +
    27namespace vulk { +
    +
    28template<typename T> +
    +
    33struct Rect
    +
    34{
    +
    35 + T left; +
    +
    36 + T top; +
    +
    37 + T width; +
    +
    38 + T height; +
    +
    39
    +
    44 + constexpr Rect() + = default; +
    +
    49 + constexpr Rect(T + aLeft, T aTop, T aWidth, T aHeight) : left{aLeft}, + top{aTop}, width{aWidth}, + height{aHeight} + {} +
    +
    54 + constexpr Rect(const Vec2<T>& + pos, const Vec2<T>& size) : left{pos.x}, + top{pos.y}, width{size.x}, + height{size.y} + {} +
    +
    55
    +
    63 + constexpr bool operator==(const Rect<T>& + right) const noexcept
    +
    64 {
    +
    65 return + left == + right.left && top == right.top + && width == right.width && + height == + right.height; +
    +
    66 }
    +
    67
    +
    75 + constexpr bool operator!=(const Rect<T>& + right) const noexcept
    +
    76 {
    +
    77 return + left != + right.left || top != right.top || width != + right.width || height + != right.height; +
    +
    78 }
    +
    79
    +
    88 + [[nodiscard]] constexpr bool contains(T + x, T y) const noexcept
    +
    89 {
    +
    90 const T + minX = std::min(left, + static_cast<T>(left + + width)); +
    +
    91 const T + maxX = std::max(left, + static_cast<T>(left + + width)); +
    +
    92 const T + minY = std::min(top, + static_cast<T>(top + + height)); +
    +
    93 const T + maxY = std::max(top, + static_cast<T>(top + + height)); +
    +
    94
    +
    95 return + (x >= minX) && (x <= maxX) && (y >= minY) && (y <= maxY); +
    +
    96 }
    +
    97
    +
    105 + [[nodiscard]] constexpr bool contains(const Vec2<T>& + point) const noexcept
    +
    106 {
    +
    107 const T + minX = std::min(left, + static_cast<T>(left + + width)); +
    +
    108 const T + maxX = std::max(left, + static_cast<T>(left + + width)); +
    +
    109 const T + minY = std::min(top, + static_cast<T>(top + + height)); +
    +
    110 const T + maxY = std::max(top, + static_cast<T>(top + + height)); +
    +
    111
    +
    112 return + (point.x >= minX) && (point.x <= maxX) && (point.y >= minY) && (point.y <= + maxY); +
    +
    113 }
    +
    114
    +
    122 + constexpr friend std::ostream& operator<<(std::ostream& + os, const Rect<T>& rect) noexcept
    +
    123 {
    +
    124 return + os << rect.left << ' ' << rect.top << ' ' << rect.width << ' ' + << rect.height; +
    +
    125 }
    +
    126};
    +
    127
    +
    128using Rectf = Rect<float>; +
    +
    129using Rectd = Rect<double>; +
    +
    130using Recti = Rect<int>; +
    +
    131using Rectu = Rect<unsigned int>; +
    +
    132} // namespace vulk +
    +
    +
    Vec2.hpp
    +
    +
    +
    vulk
    +
    Definition: Color.hpp:25
    +
    +
    +
    vulk::Key::T +
    +
    @ T
    +
    +
    +
    vulk::Rect
    +
    The Rect structure that can be use for mathematical purpose or for setting hitboxes for + example. +
    +
    Definition: Rect.hpp:34
    +
    +
    +
    vulk::Rect::contains
    +
    constexpr bool contains(T x, T y) const noexcept
    +
    Definition: Rect.hpp:88
    +
    +
    +
    vulk::Rect::left +
    +
    T left
    +
    Definition: Rect.hpp:35
    +
    +
    +
    vulk::Rect::operator!=
    +
    constexpr bool operator!=(const Rect< T > &right) const noexcept
    +
    Definition: Rect.hpp:75
    +
    +
    +
    vulk::Rect::Rect +
    +
    constexpr Rect()=default
    +
    +
    +
    vulk::Rect::operator<< +
    +
    constexpr friend std::ostream & operator<<(std::ostream &os, const Rect< T + > &rect) noexcept +
    +
    Definition: Rect.hpp:122
    +
    +
    +
    vulk::Rect::contains
    +
    constexpr bool contains(const Vec2< T > &point) const noexcept
    +
    Definition: Rect.hpp:105
    +
    +
    +
    vulk::Rect::operator==
    +
    constexpr bool operator==(const Rect< T > &right) const noexcept
    +
    Definition: Rect.hpp:63
    +
    +
    +
    vulk::Rect::Rect +
    +
    constexpr Rect(T aLeft, T aTop, T aWidth, T aHeight)
    +
    Definition: Rect.hpp:49
    +
    +
    +
    vulk::Rect::height +
    +
    T height
    +
    Definition: Rect.hpp:38
    +
    +
    +
    vulk::Rect::top +
    +
    T top
    +
    Definition: Rect.hpp:36
    +
    +
    +
    vulk::Rect::width +
    +
    T width
    +
    Definition: Rect.hpp:37
    +
    +
    +
    vulk::Rect::Rect +
    +
    constexpr Rect(const Vec2< T > &pos, const Vec2< T > &size)
    +
    Definition: Rect.hpp:54
    +
    +
    +
    vulk::Vec2
    +
    The Vec2 structure that can be use to create objects or do mathematical operations.
    +
    Definition: Vec2.hpp:32
    +
    diff --git a/documentation/html/_shader_8hpp_source.html b/documentation/html/_shader_8hpp_source.html index b816d1c..f2ca98c 100644 --- a/documentation/html/_shader_8hpp_source.html +++ b/documentation/html/_shader_8hpp_source.html @@ -101,7 +101,10 @@
    vulk::Shader::Type
    vk::ShaderStageFlagBits Type
    Definition: Shader.hpp:31
    vulk::Shader::Shader
    Shader(vk::Device &device, const char *filePath, Type type)
    Definition: Shader.cpp:28
    vulk::Shader::~Shader
    ~Shader()
    Definition: Shader.cpp:43
    -
    vulk
    Definition: ContextGLFW.hpp:26
    +
    +
    vulk
    +
    Definition: Color.hpp:25
    +
    diff --git a/documentation/html/_time_8hpp_source.html b/documentation/html/_time_8hpp_source.html index c73f42b..0c0d987 100644 --- a/documentation/html/_time_8hpp_source.html +++ b/documentation/html/_time_8hpp_source.html @@ -60,24 +60,65 @@
    12 * in the product documentation would be appreciated but is not required.
    13 *
    14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
    -
    15 * as being the original software.
    -
    16 *
    -
    17 * 3. This notice may not be removed or altered from any source distribution.
    -
    18 */
    -
    19
    -
    20#pragma once
    -
    21
    -
    22#include <chrono>
    -
    23
    -
    24namespace vulk {
    -
    25using Clock = std::chrono::high_resolution_clock;
    -
    26using Duration = std::chrono::duration<float>;
    -
    27using TimePoint = decltype(Clock::now());
    -
    28} // namespace vulk
    -
    vulk
    Definition: ContextGLFW.hpp:26
    -
    vulk::Clock
    std::chrono::high_resolution_clock Clock
    Definition: Time.hpp:25
    -
    vulk::TimePoint
    decltype(Clock::now()) TimePoint
    Definition: Time.hpp:27
    -
    vulk::Duration
    std::chrono::duration< float > Duration
    Definition: Time.hpp:26
    +
    15 * as being the original software. +
    +
    16 * +
    +
    17 * 3. This notice may not be removed or altered from any source distribution. +
    +
    18 */ +
    +
    19
    +
    20#pragma once +
    +
    21
    +
    22#include <chrono> +
    +
    23
    +
    24namespace vulk { +
    +
    28using Clock = + std::chrono::high_resolution_clock; +
    +
    29
    +
    33using Duration = + std::chrono::duration<float>; +
    +
    34
    +
    38using TimePoint = + decltype(Clock::now()); +
    +
    39} // namespace vulk +
    +
    +
    vulk
    +
    Definition: Color.hpp:25
    +
    +
    +
    vulk::Clock
    +
    std::chrono::high_resolution_clock Clock
    +
    Definition: Time.hpp:28
    +
    +
    +
    vulk::TimePoint
    +
    decltype(Clock::now()) TimePoint
    +
    Definition: Time.hpp:38
    +
    +
    +
    vulk::Duration
    +
    std::chrono::duration< float > Duration
    +
    Definition: Time.hpp:33
    +
    diff --git a/documentation/html/_vec2_8hpp.html b/documentation/html/_vec2_8hpp.html index 4ec348a..376b0ff 100644 --- a/documentation/html/_vec2_8hpp.html +++ b/documentation/html/_vec2_8hpp.html @@ -59,6 +59,13 @@

    Classes

    struct  vulk::Vec2< T >
     The Vec2 + structure that can be use to create objects or do mathematical operations. More...
     
    + + + +

    diff --git a/documentation/html/_vec2_8hpp_source.html b/documentation/html/_vec2_8hpp_source.html index 00fddd6..442ae3b 100644 --- a/documentation/html/_vec2_8hpp_source.html +++ b/documentation/html/_vec2_8hpp_source.html @@ -62,134 +62,505 @@
    14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
    15 * as being the original software.
    16 *
    -
    17 * 3. This notice may not be removed or altered from any source distribution.
    -
    18 */
    -
    19
    -
    20#pragma once
    -
    21
    -
    22#include <cmath>
    -
    23#include <ostream>
    -
    24
    -
    25namespace vulk {
    -
    26template<typename T>
    -
    27struct Vec2
    -
    28{
    -
    29 T x;
    -
    30 T y;
    -
    31
    -
    36 constexpr Vec2() = default;
    -
    41 constexpr Vec2(T aX, T aY) : x{aX}, y{aY} {}
    -
    46 constexpr explicit Vec2(T value) : x{value}, y{value} {}
    -
    47
    -
    53 constexpr Vec2 operator-() const noexcept { return Vec2{-x, -y}; }
    -
    54
    -
    61 constexpr Vec2& operator+=(const Vec2& rhs)
    -
    62 {
    -
    63 x += rhs.x;
    -
    64 y += rhs.y;
    -
    65 return *this;
    -
    66 }
    -
    67
    -
    74 constexpr Vec2& operator-=(const Vec2& rhs)
    -
    75 {
    -
    76 x -= rhs.x;
    -
    77 y -= rhs.y;
    -
    78 return *this;
    -
    79 }
    -
    80
    -
    87 constexpr Vec2& operator*=(const T value)
    -
    88 {
    -
    89 x *= value;
    -
    90 y *= value;
    -
    91 return *this;
    -
    92 }
    -
    93
    -
    100 constexpr Vec2& operator/=(const T value) { return *this *= (static_cast<T>(1) / value); }
    -
    101
    -
    109 [[nodiscard]] constexpr static T dot(const Vec2& lhs, const Vec2& rhs) noexcept
    -
    110 {
    -
    111 return lhs.x * rhs.x + lhs.y * rhs.y;
    -
    112 }
    -
    113
    -
    121 [[nodiscard]] constexpr static T cross(const Vec2& lhs, const Vec2& rhs) noexcept
    -
    122 {
    -
    123 return lhs.x * rhs.y - lhs.y * rhs.x;
    -
    124 }
    -
    125
    -
    131 [[nodiscard]] constexpr T lengthSquared() const noexcept { return x * x + y * y; }
    -
    137 [[nodiscard]] constexpr T length() const noexcept { return static_cast<T>(std::sqrt(lengthSquared())); }
    -
    143 [[nodiscard]] constexpr Vec2 normalized() const noexcept { return *this / length(); }
    -
    144
    -
    152 constexpr friend std::ostream& operator<<(std::ostream& os, const Vec2& Vec2) noexcept
    -
    153 {
    -
    154 return os << Vec2.x << ' ' << Vec2.y << ' ';
    -
    155 }
    -
    156};
    -
    157
    -
    158template<typename T>
    -
    159constexpr Vec2<T> operator+(const Vec2<T>& lhs, const Vec2<T>& rhs) noexcept
    -
    160{
    -
    161 return Vec2{lhs.x + rhs.x, lhs.y + rhs.y};
    -
    162}
    -
    163
    -
    164template<typename T>
    -
    165constexpr Vec2<T> operator-(const Vec2<T>& lhs, const Vec2<T>& rhs) noexcept
    -
    166{
    -
    167 return Vec2{lhs.x - rhs.x, lhs.y - rhs.y};
    -
    168}
    -
    169
    -
    170template<typename T>
    -
    171constexpr Vec2<T> operator*(const Vec2<T>& lhs, const Vec2<T>& rhs) noexcept
    -
    172{
    -
    173 return Vec2{lhs.x * rhs.x, lhs.y * rhs.y};
    -
    174}
    -
    175
    -
    176template<typename T>
    -
    177constexpr Vec2<T> operator*(const Vec2<T>& lhs, T t) noexcept
    -
    178{
    -
    179 return Vec2{lhs.x * t, lhs.y * t};
    -
    180}
    -
    181
    -
    182template<typename T>
    -
    183constexpr Vec2<T> operator*(T t, const Vec2<T>& rhs) noexcept
    -
    184{
    -
    185 return rhs * t;
    -
    186}
    -
    187
    -
    188template<typename T>
    -
    189constexpr Vec2<T> operator/(const Vec2<T>& lhs, T t) noexcept
    -
    190{
    -
    191 return (1 / t) * lhs;
    -
    192}
    -
    193
    -
    194using Vec2f = Vec2<float>;
    -
    195using Vec2d = Vec2<double>;
    -
    196using Vec2i = Vec2<int>;
    -
    197using Vec2u = Vec2<unsigned int>;
    -
    198} // namespace vulk
    -
    vulk
    Definition: ContextGLFW.hpp:26
    -
    vulk::operator*
    constexpr Vec2< T > operator*(const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
    Definition: Vec2.hpp:171
    -
    vulk::operator/
    constexpr Vec2< T > operator/(const Vec2< T > &lhs, T t) noexcept
    Definition: Vec2.hpp:189
    -
    vulk::operator+
    constexpr Vec2< T > operator+(const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
    Definition: Vec2.hpp:159
    - -
    vulk::operator-
    constexpr Vec2< T > operator-(const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
    Definition: Vec2.hpp:165
    -
    vulk::Vec2
    Definition: Vec2.hpp:28
    -
    vulk::Vec2::normalized
    constexpr Vec2 normalized() const noexcept
    Definition: Vec2.hpp:143
    -
    vulk::Vec2::Vec2
    constexpr Vec2()=default
    -
    vulk::Vec2::x
    T x
    Definition: Vec2.hpp:29
    -
    vulk::Vec2::lengthSquared
    constexpr T lengthSquared() const noexcept
    Definition: Vec2.hpp:131
    -
    vulk::Vec2::length
    constexpr T length() const noexcept
    Definition: Vec2.hpp:137
    -
    vulk::Vec2::cross
    constexpr static T cross(const Vec2 &lhs, const Vec2 &rhs) noexcept
    Definition: Vec2.hpp:121
    -
    vulk::Vec2::y
    T y
    Definition: Vec2.hpp:30
    -
    vulk::Vec2::dot
    constexpr static T dot(const Vec2 &lhs, const Vec2 &rhs) noexcept
    Definition: Vec2.hpp:109
    -
    vulk::Vec2::Vec2
    constexpr Vec2(T aX, T aY)
    Definition: Vec2.hpp:41
    -
    vulk::Vec2::operator+=
    constexpr Vec2 & operator+=(const Vec2 &rhs)
    Definition: Vec2.hpp:61
    -
    vulk::Vec2::operator-
    constexpr Vec2 operator-() const noexcept
    Definition: Vec2.hpp:53
    -
    vulk::Vec2::operator-=
    constexpr Vec2 & operator-=(const Vec2 &rhs)
    Definition: Vec2.hpp:74
    -
    vulk::Vec2::operator<<
    constexpr friend std::ostream & operator<<(std::ostream &os, const Vec2 &Vec2) noexcept
    Definition: Vec2.hpp:152
    -
    vulk::Vec2::Vec2
    constexpr Vec2(T value)
    Definition: Vec2.hpp:46
    -
    vulk::Vec2::operator/=
    constexpr Vec2 & operator/=(const T value)
    Definition: Vec2.hpp:100
    -
    vulk::Vec2::operator*=
    constexpr Vec2 & operator*=(const T value)
    Definition: Vec2.hpp:87
    +
    17 * 3. This notice may not be removed or altered from any source distribution. +
    +
    18 */ +
    +
    19
    +
    20#pragma once +
    +
    21
    +
    22#include <cmath> +
    +
    23#include <ostream> +
    +
    24
    +
    25namespace vulk { +
    +
    26template<typename T> +
    +
    31struct Vec2
    +
    32{
    +
    33 + T x; +
    +
    34 + T y; +
    +
    35
    +
    40 + constexpr Vec2() + = default; +
    +
    47 + constexpr Vec2(T + aX, T aY) : x{aX}, + y{aY} {} +
    +
    53 + constexpr explicit Vec2(T + value) : x{value}, + y{value} {} +
    +
    54
    +
    60 + constexpr Vec2 operator-() + const noexcept { return Vec2{-x, -y}; } +
    +
    61
    +
    68 + constexpr Vec2& + operator+=(const Vec2& + rhs) +
    +
    69 {
    +
    70 x + += rhs.x; +
    +
    71 y + += rhs.y; +
    +
    72 return + *this; +
    +
    73 }
    +
    74
    +
    81 + constexpr Vec2& + operator-=(const Vec2& + rhs) +
    +
    82 {
    +
    83 x + -= rhs.x; +
    +
    84 y + -= rhs.y; +
    +
    85 return + *this; +
    +
    86 }
    +
    87
    +
    94 + constexpr Vec2& + operator*=(const T value) +
    +
    95 {
    +
    96 x + *= value; +
    +
    97 y + *= value; +
    +
    98 return + *this; +
    +
    99 }
    +
    100
    +
    107 + constexpr Vec2& + operator/=(const T value) { return *this + *= (static_cast<T>(1) / value); } +
    +
    108
    +
    116 + [[nodiscard]] constexpr static T dot(const Vec2& + lhs, const Vec2& + rhs) noexcept
    +
    117 {
    +
    118 return + lhs.x * rhs.x + lhs.y * rhs.y; +
    +
    119 }
    +
    120
    +
    128 + [[nodiscard]] constexpr static T cross(const Vec2& + lhs, const Vec2& + rhs) noexcept
    +
    129 {
    +
    130 return + lhs.x * rhs.y - lhs.y * rhs.x; +
    +
    131 }
    +
    132
    +
    138 + [[nodiscard]] constexpr T + lengthSquared() + const noexcept { return x + * x + y * y; } +
    +
    144 + [[nodiscard]] constexpr T + length() const + noexcept { return static_cast<T>(std::sqrt(lengthSquared())); + } +
    +
    150 + [[nodiscard]] constexpr Vec2 + normalized() + const noexcept { return *this / length(); + } +
    +
    151
    +
    159 + constexpr friend std::ostream& operator<<(std::ostream& + os, const Vec2& + Vec2) noexcept
    +
    160 {
    +
    161 return + os << Vec2.x + << ' ' << Vec2.y << + ' '; +
    +
    162 }
    +
    163};
    +
    164
    +
    165template<typename T> +
    +
    166constexpr Vec2<T> + operator+(const Vec2<T>& + lhs, const Vec2<T>& rhs) noexcept
    +
    167{
    +
    168 return + Vec2{lhs.x + + rhs.x, lhs.y + rhs.y}; +
    +
    169}
    +
    170
    +
    171template<typename T> +
    +
    172constexpr Vec2<T> + operator-(const Vec2<T>& + lhs, const Vec2<T>& rhs) noexcept
    +
    173{
    +
    174 return + Vec2{lhs.x + - rhs.x, lhs.y - rhs.y}; +
    +
    175}
    +
    176
    +
    177template<typename T> +
    +
    178constexpr Vec2<T> + operator*(const Vec2<T>& + lhs, const Vec2<T>& rhs) noexcept
    +
    179{
    +
    180 return + Vec2{lhs.x + * rhs.x, lhs.y * rhs.y}; +
    +
    181}
    +
    182
    +
    183template<typename T> +
    +
    184constexpr Vec2<T> + operator*(const Vec2<T>& + lhs, T t) noexcept
    +
    185{
    +
    186 return + Vec2{lhs.x + * t, lhs.y * t}; +
    +
    187}
    +
    188
    +
    189template<typename T> +
    +
    190constexpr Vec2<T> + operator*(T t, const Vec2<T>& + rhs) noexcept
    +
    191{
    +
    192 return + rhs * t; +
    +
    193}
    +
    194
    +
    195template<typename T> +
    +
    196constexpr Vec2<T> + operator/(const Vec2<T>& + lhs, T t) noexcept
    +
    197{
    +
    198 return + (1 / t) * lhs; +
    +
    199}
    +
    200
    +
    201using Vec2f = Vec2<float>; +
    +
    202using Vec2d = Vec2<double>; +
    +
    203using Vec2i = Vec2<int>; +
    +
    204using Vec2u = Vec2<unsigned int>; +
    +
    205} // namespace vulk +
    +
    +
    vulk
    +
    Definition: Color.hpp:25
    +
    +
    +
    vulk::operator*
    +
    constexpr Vec2< T > operator*(const Vec2< T > &lhs, const Vec2< T > + &rhs) noexcept +
    +
    Definition: Vec2.hpp:178
    +
    +
    +
    vulk::operator/
    +
    constexpr Vec2< T > operator/(const Vec2< T > &lhs, T t) noexcept
    +
    Definition: Vec2.hpp:196
    +
    +
    +
    vulk::operator+
    +
    constexpr Vec2< T > operator+(const Vec2< T > &lhs, const Vec2< T > + &rhs) noexcept +
    +
    Definition: Vec2.hpp:166
    +
    +
    +
    vulk::Key::T +
    +
    @ T
    +
    +
    +
    vulk::operator-
    +
    constexpr Vec2< T > operator-(const Vec2< T > &lhs, const Vec2< T > + &rhs) noexcept +
    +
    Definition: Vec2.hpp:172
    +
    +
    +
    vulk::Vec2
    +
    The Vec2 structure that can be use to create objects or do mathematical operations.
    +
    Definition: Vec2.hpp:32
    +
    +
    +
    vulk::Vec2::normalized
    +
    constexpr Vec2 normalized() const noexcept
    +
    Return the normalized version of the Vec2.
    +
    Definition: Vec2.hpp:150
    +
    +
    +
    vulk::Vec2::Vec2 +
    +
    constexpr Vec2()=default
    +
    The default constructor.
    +
    +
    +
    vulk::Vec2::x
    +
    T x
    +
    Definition: Vec2.hpp:33
    +
    +
    +
    vulk::Vec2::lengthSquared +
    +
    constexpr T lengthSquared() const noexcept
    +
    Return the length squared of the Vec2.
    +
    Definition: Vec2.hpp:138
    +
    +
    +
    vulk::Vec2::length +
    +
    constexpr T length() const noexcept
    +
    Reutrn the lenth of the Vec2.
    +
    Definition: Vec2.hpp:144
    +
    +
    +
    vulk::Vec2::cross +
    +
    constexpr static T cross(const Vec2 &lhs, const Vec2 &rhs) noexcept
    +
    Return the cross product of two Vec2.
    +
    Definition: Vec2.hpp:128
    +
    +
    +
    vulk::Vec2::y
    +
    T y
    +
    Definition: Vec2.hpp:34
    +
    +
    +
    vulk::Vec2::dot +
    +
    constexpr static T dot(const Vec2 &lhs, const Vec2 &rhs) noexcept
    +
    Return the dot product of two Vec2.
    +
    Definition: Vec2.hpp:116
    +
    +
    +
    vulk::Vec2::Vec2 +
    +
    constexpr Vec2(T aX, T aY)
    +
    Vec2 constructor with two different parameters.
    +
    Definition: Vec2.hpp:47
    +
    +
    +
    vulk::Vec2::operator+=
    +
    constexpr Vec2 & operator+=(const Vec2 &rhs)
    +
    Addition between two Vec2.
    +
    Definition: Vec2.hpp:68
    +
    +
    +
    vulk::Vec2::operator-
    +
    constexpr Vec2 operator-() const noexcept
    +
    Return the negative vector.
    +
    Definition: Vec2.hpp:60
    +
    +
    +
    vulk::Vec2::operator-=
    +
    constexpr Vec2 & operator-=(const Vec2 &rhs)
    +
    Substraction between two Vec2.
    +
    Definition: Vec2.hpp:81
    +
    +
    +
    vulk::Vec2::operator<< +
    +
    constexpr friend std::ostream & operator<<(std::ostream &os, const Vec2 &Vec2) + noexcept +
    +
    Definition: Vec2.hpp:159
    +
    +
    +
    vulk::Vec2::Vec2 +
    +
    constexpr Vec2(T value)
    +
    Vec2 constructor with one parameter.
    +
    Definition: Vec2.hpp:53
    +
    +
    +
    vulk::Vec2::operator/=
    +
    constexpr Vec2 & operator/=(const T value)
    +
    Division between a Vec2 and a value.
    +
    Definition: Vec2.hpp:107
    +
    +
    +
    vulk::Vec2::operator*=
    +
    constexpr Vec2 & operator*=(const T value)
    +
    Multiplication between a Vec2 and a value.
    +
    Definition: Vec2.hpp:94
    +
    diff --git a/documentation/html/_vec3_8hpp.html b/documentation/html/_vec3_8hpp.html index 97ab5d9..bd3ce18 100644 --- a/documentation/html/_vec3_8hpp.html +++ b/documentation/html/_vec3_8hpp.html @@ -59,6 +59,13 @@

    Classes

    struct  vulk::Vec3< T >
     The Vec3 + structure that can be use to create objects or do mathematical operations. More...
     

    diff --git a/documentation/html/_vec3_8hpp_source.html b/documentation/html/_vec3_8hpp_source.html index 7f76270..5bb9231 100644 --- a/documentation/html/_vec3_8hpp_source.html +++ b/documentation/html/_vec3_8hpp_source.html @@ -62,139 +62,530 @@
    14 * 2. Altered source versions must be plainly marked as such, and must not be misrepresented
    15 * as being the original software.
    16 *
    -
    17 * 3. This notice may not be removed or altered from any source distribution.
    -
    18 */
    -
    19
    -
    20#pragma once
    -
    21
    -
    22#include <cmath>
    -
    23#include <ostream>
    -
    24
    -
    25namespace vulk {
    -
    26template<typename T>
    -
    27struct Vec3
    -
    28{
    -
    29 T x;
    -
    30 T y;
    -
    31 T z;
    -
    32
    -
    37 constexpr Vec3() = default;
    -
    42 constexpr Vec3(T aX, T aY, T aZ) : x{aX}, y{aY}, z{aZ} {}
    -
    47 constexpr explicit Vec3(T value) : x{value}, y{value}, z{value} {}
    -
    48
    -
    54 constexpr Vec3 operator-() const noexcept { return Vec3{-x, -y, -z}; }
    -
    55
    -
    62 constexpr Vec3& operator+=(const Vec3& rhs)
    -
    63 {
    -
    64 x += rhs.x;
    -
    65 y += rhs.y;
    -
    66 z += rhs.z;
    -
    67 return *this;
    -
    68 }
    -
    69
    -
    76 constexpr Vec3& operator-=(const Vec3& rhs)
    -
    77 {
    -
    78 x -= rhs.x;
    -
    79 y -= rhs.y;
    -
    80 z -= rhs.z;
    -
    81 return *this;
    -
    82 }
    -
    83
    -
    90 constexpr Vec3& operator*=(const T value)
    -
    91 {
    -
    92 x *= value;
    -
    93 y *= value;
    -
    94 z *= value;
    -
    95 return *this;
    -
    96 }
    -
    97
    -
    104 constexpr Vec3& operator/=(const T value) { return *this *= (static_cast<T>(1) / value); }
    -
    105
    -
    113 [[nodiscard]] constexpr static T dot(const Vec3& lhs, const Vec3& rhs) noexcept
    -
    114 {
    -
    115 return lhs.x * rhs.x + lhs.y * rhs.y + lhs.z * rhs.z;
    -
    116 }
    -
    117
    -
    125 [[nodiscard]] constexpr static Vec3 cross(const Vec3& lhs, const Vec3& rhs) noexcept
    -
    126 {
    -
    127 return Vec3{lhs.y * rhs.z - lhs.z * rhs.y, lhs.z * rhs.x - lhs.x * rhs.z, lhs.x * rhs.y - lhs.y * rhs.x};
    -
    128 }
    -
    129
    -
    135 [[nodiscard]] constexpr T lengthSquared() const noexcept { return x * x + y * y + z * z; }
    -
    141 [[nodiscard]] constexpr T length() const noexcept { return static_cast<T>(std::sqrt(lengthSquared())); }
    -
    147 [[nodiscard]] constexpr Vec3 normalized() const noexcept { return *this / length(); }
    -
    148
    -
    156 constexpr friend std::ostream& operator<<(std::ostream& os, const Vec3& vec3) noexcept
    -
    157 {
    -
    158 return os << vec3.x << ' ' << vec3.y << ' ' << vec3.z;
    -
    159 }
    -
    160};
    -
    161
    -
    162template<typename T>
    -
    163constexpr Vec3<T> operator+(const Vec3<T>& lhs, const Vec3<T>& rhs) noexcept
    -
    164{
    -
    165 return Vec3{lhs.x + rhs.x, lhs.y + rhs.y, lhs.z + rhs.z};
    -
    166}
    -
    167
    -
    168template<typename T>
    -
    169constexpr Vec3<T> operator-(const Vec3<T>& lhs, const Vec3<T>& rhs) noexcept
    -
    170{
    -
    171 return Vec3{lhs.x - rhs.x, lhs.y - rhs.y, lhs.z - rhs.z};
    -
    172}
    -
    173
    -
    174template<typename T>
    -
    175constexpr Vec3<T> operator*(const Vec3<T>& lhs, const Vec3<T>& rhs) noexcept
    -
    176{
    -
    177 return Vec3{lhs.x * rhs.x, lhs.y * rhs.y, lhs.z * rhs.z};
    -
    178}
    -
    179
    -
    180template<typename T>
    -
    181constexpr Vec3<T> operator*(const Vec3<T>& lhs, T t) noexcept
    -
    182{
    -
    183 return Vec3{lhs.x * t, lhs.y * t, lhs.z * t};
    -
    184}
    -
    185
    -
    186template<typename T>
    -
    187constexpr Vec3<T> operator*(T t, const Vec3<T>& rhs) noexcept
    -
    188{
    -
    189 return rhs * t;
    -
    190}
    -
    191
    -
    192template<typename T>
    -
    193constexpr Vec3<T> operator/(const Vec3<T>& lhs, T t) noexcept
    -
    194{
    -
    195 return (1 / t) * lhs;
    -
    196}
    -
    197
    -
    198using Vec3f = Vec3<float>;
    -
    199using Vec3d = Vec3<double>;
    -
    200using Vec3i = Vec3<int>;
    -
    201using Vec3u = Vec3<unsigned int>;
    -
    202} // namespace vulk
    -
    vulk
    Definition: ContextGLFW.hpp:26
    -
    vulk::operator*
    constexpr Vec2< T > operator*(const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
    Definition: Vec2.hpp:171
    -
    vulk::operator/
    constexpr Vec2< T > operator/(const Vec2< T > &lhs, T t) noexcept
    Definition: Vec2.hpp:189
    -
    vulk::operator+
    constexpr Vec2< T > operator+(const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
    Definition: Vec2.hpp:159
    - -
    vulk::operator-
    constexpr Vec2< T > operator-(const Vec2< T > &lhs, const Vec2< T > &rhs) noexcept
    Definition: Vec2.hpp:165
    -
    vulk::Vec3
    Definition: Vec3.hpp:28
    -
    vulk::Vec3::y
    T y
    Definition: Vec3.hpp:30
    -
    vulk::Vec3::operator/=
    constexpr Vec3 & operator/=(const T value)
    Definition: Vec3.hpp:104
    -
    vulk::Vec3::cross
    constexpr static Vec3 cross(const Vec3 &lhs, const Vec3 &rhs) noexcept
    Definition: Vec3.hpp:125
    -
    vulk::Vec3::Vec3
    constexpr Vec3(T aX, T aY, T aZ)
    Definition: Vec3.hpp:42
    -
    vulk::Vec3::z
    T z
    Definition: Vec3.hpp:31
    -
    vulk::Vec3::length
    constexpr T length() const noexcept
    Definition: Vec3.hpp:141
    -
    vulk::Vec3::operator-=
    constexpr Vec3 & operator-=(const Vec3 &rhs)
    Definition: Vec3.hpp:76
    -
    vulk::Vec3::operator-
    constexpr Vec3 operator-() const noexcept
    Definition: Vec3.hpp:54
    -
    vulk::Vec3::normalized
    constexpr Vec3 normalized() const noexcept
    Definition: Vec3.hpp:147
    -
    vulk::Vec3::Vec3
    constexpr Vec3(T value)
    Definition: Vec3.hpp:47
    -
    vulk::Vec3::lengthSquared
    constexpr T lengthSquared() const noexcept
    Definition: Vec3.hpp:135
    -
    vulk::Vec3::Vec3
    constexpr Vec3()=default
    -
    vulk::Vec3::x
    T x
    Definition: Vec3.hpp:29
    -
    vulk::Vec3::operator<<
    constexpr friend std::ostream & operator<<(std::ostream &os, const Vec3 &vec3) noexcept
    Definition: Vec3.hpp:156
    -
    vulk::Vec3::dot
    constexpr static T dot(const Vec3 &lhs, const Vec3 &rhs) noexcept
    Definition: Vec3.hpp:113
    -
    vulk::Vec3::operator+=
    constexpr Vec3 & operator+=(const Vec3 &rhs)
    Definition: Vec3.hpp:62
    -
    vulk::Vec3::operator*=
    constexpr Vec3 & operator*=(const T value)
    Definition: Vec3.hpp:90
    +
    17 * 3. This notice may not be removed or altered from any source distribution. +
    +
    18 */ +
    +
    19
    +
    20#pragma once +
    +
    21
    +
    22#include <cmath> +
    +
    23#include <ostream> +
    +
    24
    +
    25namespace vulk { +
    +
    26template<typename T> +
    +
    32struct Vec3
    +
    33{
    +
    34 + T x; +
    +
    35 + T y; +
    +
    36 + T z; +
    +
    37
    +
    42 + constexpr Vec3() + = default; +
    +
    50 + constexpr Vec3(T + aX, T aY, T aZ) : x{aX}, + y{aY}, z{aZ} {} +
    +
    56 + constexpr explicit Vec3(T + value) : x{value}, + y{value}, z{value} + {} +
    +
    57
    +
    63 + constexpr Vec3 operator-() + const noexcept { return Vec3{-x, -y, -z}; } +
    +
    64
    +
    71 + constexpr Vec3& + operator+=(const Vec3& + rhs) +
    +
    72 {
    +
    73 x + += rhs.x; +
    +
    74 y + += rhs.y; +
    +
    75 z + += rhs.z; +
    +
    76 return + *this; +
    +
    77 }
    +
    78
    +
    85 + constexpr Vec3& + operator-=(const Vec3& + rhs) +
    +
    86 {
    +
    87 x + -= rhs.x; +
    +
    88 y + -= rhs.y; +
    +
    89 z + -= rhs.z; +
    +
    90 return + *this; +
    +
    91 }
    +
    92
    +
    99 + constexpr Vec3& + operator*=(const T value) +
    +
    100 {
    +
    101 x + *= value; +
    +
    102 y + *= value; +
    +
    103 z + *= value; +
    +
    104 return + *this; +
    +
    105 }
    +
    106
    +
    113 + constexpr Vec3& + operator/=(const T value) { return *this + *= (static_cast<T>(1) / value); } +
    +
    114
    +
    122 + [[nodiscard]] constexpr static T dot(const Vec3& + lhs, const Vec3& + rhs) noexcept
    +
    123 {
    +
    124 return + lhs.x * rhs.x + lhs.y * rhs.y + lhs.z * rhs.z; +
    +
    125 }
    +
    126
    +
    134 + [[nodiscard]] constexpr static Vec3 cross(const Vec3& + lhs, const Vec3& + rhs) noexcept
    +
    135 {
    +
    136 return + Vec3{lhs.y + * rhs.z - lhs.z * rhs.y, lhs.z * rhs.x - lhs.x * rhs.z, lhs.x * rhs.y - lhs.y * rhs.x}; +
    +
    137 }
    +
    138
    +
    144 + [[nodiscard]] constexpr T + lengthSquared() + const noexcept { return x + * x + y * y + z * z; } +
    +
    150 + [[nodiscard]] constexpr T + length() const + noexcept { return static_cast<T>(std::sqrt(lengthSquared())); + } +
    +
    156 + [[nodiscard]] constexpr Vec3 + normalized() + const noexcept { return *this / length(); + } +
    +
    157
    +
    165 + constexpr friend std::ostream& operator<<(std::ostream& + os, const Vec3& + vec3) noexcept
    +
    166 {
    +
    167 return + os << vec3.x << ' ' << vec3.y << ' ' << vec3.z; +
    +
    168 }
    +
    169};
    +
    170
    +
    171template<typename T> +
    +
    172constexpr Vec3<T> + operator+(const Vec3<T>& + lhs, const Vec3<T>& rhs) noexcept
    +
    173{
    +
    174 return + Vec3{lhs.x + + rhs.x, lhs.y + rhs.y, lhs.z + rhs.z}; +
    +
    175}
    +
    176
    +
    177template<typename T> +
    +
    178constexpr Vec3<T> + operator-(const Vec3<T>& + lhs, const Vec3<T>& rhs) noexcept
    +
    179{
    +
    180 return + Vec3{lhs.x + - rhs.x, lhs.y - rhs.y, lhs.z - rhs.z}; +
    +
    181}
    +
    182
    +
    183template<typename T> +
    +
    184constexpr Vec3<T> + operator*(const Vec3<T>& + lhs, const Vec3<T>& rhs) noexcept
    +
    185{
    +
    186 return + Vec3{lhs.x + * rhs.x, lhs.y * rhs.y, lhs.z * rhs.z}; +
    +
    187}
    +
    188
    +
    189template<typename T> +
    +
    190constexpr Vec3<T> + operator*(const Vec3<T>& + lhs, T t) noexcept
    +
    191{
    +
    192 return + Vec3{lhs.x + * t, lhs.y * t, lhs.z * t}; +
    +
    193}
    +
    194
    +
    195template<typename T> +
    +
    196constexpr Vec3<T> + operator*(T t, const Vec3<T>& + rhs) noexcept
    +
    197{
    +
    198 return + rhs * t; +
    +
    199}
    +
    200
    +
    201template<typename T> +
    +
    202constexpr Vec3<T> + operator/(const Vec3<T>& + lhs, T t) noexcept
    +
    203{
    +
    204 return + (1 / t) * lhs; +
    +
    205}
    +
    206
    +
    207using Vec3f = Vec3<float>; +
    +
    208using Vec3d = Vec3<double>; +
    +
    209using Vec3i = Vec3<int>; +
    +
    210using Vec3u = Vec3<unsigned int>; +
    +
    211} // namespace vulk +
    +
    +
    vulk
    +
    Definition: Color.hpp:25
    +
    +
    +
    vulk::operator*
    +
    constexpr Vec2< T > operator*(const Vec2< T > &lhs, const Vec2< T > + &rhs) noexcept +
    +
    Definition: Vec2.hpp:178
    +
    +
    +
    vulk::operator/
    +
    constexpr Vec2< T > operator/(const Vec2< T > &lhs, T t) noexcept
    +
    Definition: Vec2.hpp:196
    +
    +
    +
    vulk::operator+
    +
    constexpr Vec2< T > operator+(const Vec2< T > &lhs, const Vec2< T > + &rhs) noexcept +
    +
    Definition: Vec2.hpp:166
    +
    +
    +
    vulk::Key::T +
    +
    @ T
    +
    +
    +
    vulk::operator-
    +
    constexpr Vec2< T > operator-(const Vec2< T > &lhs, const Vec2< T > + &rhs) noexcept +
    +
    Definition: Vec2.hpp:172
    +
    +
    +
    vulk::Vec3
    +
    The Vec3 structure that can be use to create objects or do mathematical operations.
    +
    Definition: Vec3.hpp:33
    +
    +
    +
    vulk::Vec3::y
    +
    T y
    +
    Definition: Vec3.hpp:35
    +
    +
    +
    vulk::Vec3::operator/=
    +
    constexpr Vec3 & operator/=(const T value)
    +
    Division between a Vec3 and a value.
    +
    Definition: Vec3.hpp:113
    +
    +
    +
    vulk::Vec3::cross +
    +
    constexpr static Vec3 cross(const Vec3 &lhs, const Vec3 &rhs) noexcept
    +
    Return the cross product of two vectors.
    +
    Definition: Vec3.hpp:134
    +
    +
    +
    vulk::Vec3::Vec3 +
    +
    constexpr Vec3(T aX, T aY, T aZ)
    +
    Vec3 constructor with three different parameters.
    +
    Definition: Vec3.hpp:50
    +
    +
    +
    vulk::Vec3::z
    +
    T z
    +
    Definition: Vec3.hpp:36
    +
    +
    +
    vulk::Vec3::length +
    +
    constexpr T length() const noexcept
    +
    Return the length of the Vec3.
    +
    Definition: Vec3.hpp:150
    +
    +
    +
    vulk::Vec3::operator-=
    +
    constexpr Vec3 & operator-=(const Vec3 &rhs)
    +
    Substraction between two Vec3.
    +
    Definition: Vec3.hpp:85
    +
    +
    +
    vulk::Vec3::operator-
    +
    constexpr Vec3 operator-() const noexcept
    +
    Return the negative vector.
    +
    Definition: Vec3.hpp:63
    +
    +
    +
    vulk::Vec3::normalized
    +
    constexpr Vec3 normalized() const noexcept
    +
    Return the normalized version of the vector.
    +
    Definition: Vec3.hpp:156
    +
    +
    +
    vulk::Vec3::Vec3 +
    +
    constexpr Vec3(T value)
    +
    Vec3 constructor with one parameter.
    +
    Definition: Vec3.hpp:56
    +
    +
    +
    vulk::Vec3::lengthSquared +
    +
    constexpr T lengthSquared() const noexcept
    +
    Return the length squared of the Vec3.
    +
    Definition: Vec3.hpp:144
    +
    +
    +
    vulk::Vec3::Vec3 +
    +
    constexpr Vec3()=default
    +
    The default constructor.
    +
    +
    +
    vulk::Vec3::x
    +
    T x
    +
    Definition: Vec3.hpp:34
    +
    +
    +
    vulk::Vec3::operator<< +
    +
    constexpr friend std::ostream & operator<<(std::ostream &os, const Vec3 &vec3) + noexcept +
    +
    Definition: Vec3.hpp:165
    +
    +
    +
    vulk::Vec3::dot +
    +
    constexpr static T dot(const Vec3 &lhs, const Vec3 &rhs) noexcept
    +
    Return the dot product of two Vec3.
    +
    Definition: Vec3.hpp:122
    +
    +
    +
    vulk::Vec3::operator+=
    +
    constexpr Vec3 & operator+=(const Vec3 &rhs)
    +
    Addition betwen two Vec3.
    +
    Definition: Vec3.hpp:71
    +
    +
    +
    vulk::Vec3::operator*=
    +
    constexpr Vec3 & operator*=(const T value)
    +
    Multiplication between a Vec3 and a value.
    +
    Definition: Vec3.hpp:99
    +
    diff --git a/documentation/html/_window_8hpp_source.html b/documentation/html/_window_8hpp_source.html index 19efbe0..2110ffd 100644 --- a/documentation/html/_window_8hpp_source.html +++ b/documentation/html/_window_8hpp_source.html @@ -109,7 +109,10 @@ -
    vulk::FrameManager
    Definition: FrameManager.hpp:32
    +
    +
    vulk::FrameManager
    +
    Definition: FrameManager.hpp:35
    +
    vulk::Window
    Definition: Window.hpp:32
    vulk::Window::isOpen
    bool isOpen() const noexcept
    Definition: Window.cpp:94
    vulk::Window::Window
    Window(const Window &)=delete
    Construct a new Window object.
    @@ -123,7 +126,10 @@
    vulk::Window::~Window
    ~Window()
    Destroy the Window object.
    Definition: Window.cpp:58
    vulk::Window::Window
    Window(unsigned int width, unsigned int height, const char *title)
    Construct a new Window object.
    Definition: Window.cpp:33
    vulk::Window::getFrameManager
    FrameManager & getFrameManager() noexcept
    Get the Frame Manager object.
    Definition: Window.hpp:110
    -
    vulk
    Definition: ContextGLFW.hpp:26
    +
    +
    vulk
    +
    Definition: Color.hpp:25
    +
    diff --git a/documentation/html/annotated.html b/documentation/html/annotated.html index 39588eb..ea6c046 100644 --- a/documentation/html/annotated.html +++ b/documentation/html/annotated.html @@ -43,28 +43,151 @@
    Here are the classes, structs, unions and interfaces with brief descriptions:
    -
    [detail level 123]
    - - - - - - - - - - - - - - - - - - - - -
     ▼Nvulk
     ▼Nutils
     CScopedProfiler
     CContextGLFW
     CContextVulkan
     CException
     CFrameManager
     CGLFWException
     CKeyboard
     CMat3
     CMouse
     CRect
     CShader
     CVec2
     CVec3
     CVulkanException
     CWindow
     CTypeChecker
     CUniformBufferObject
     CVertex
    +
    [detail level 123] +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
     ▼Nvulk
     ▼Nutils
     CScopedProfiler
     CColor +
     CContextGLFW +
     CContextVulkan +
     CException +
     CFrameManager +
     CGLFWException
     CKeyboard
     CMat3 + The Mat3 + structure that can be use for mathematical purpose +
     CMouse +
     CRect + The Rect + structure that can be use for mathematical purpose or for setting hitboxes for example +
     CShader +
     CVec2 + The Vec2 + structure that can be use to create objects or do mathematical operations +
     CVec3 + The Vec3 + structure that can be use to create objects or do mathematical operations +
     CVulkanException +
     CWindow +
     CTypeChecker
     CUniformBufferObject +
     CVertex
    diff --git a/documentation/html/classes.html b/documentation/html/classes.html index 5da691b..39578d8 100644 --- a/documentation/html/classes.html +++ b/documentation/html/classes.html @@ -45,8 +45,15 @@
    C | E | F | G | K | M | R | S | T | U | V | W
    -
    C
    -
    ContextGLFW (vulk)
    ContextVulkan (vulk)
    +
    C
    +
    Color (vulk)
    +
    ContextGLFW (vulk) +
    +
    ContextVulkan (vulk) +
    +
    E
    Exception (vulk)
    diff --git a/documentation/html/classvulk_1_1_frame_manager-members.html b/documentation/html/classvulk_1_1_frame_manager-members.html index f5df82b..32770e7 100644 --- a/documentation/html/classvulk_1_1_frame_manager-members.html +++ b/documentation/html/classvulk_1_1_frame_manager-members.html @@ -49,15 +49,70 @@

    This is the complete list of members for vulk::FrameManager, including all inherited members.

    - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FrameManager()vulk::FrameManager
    FramerateStringBuffer typedefvulk::FrameManager
    getDeltaTime() const noexceptvulk::FrameManagerinline
    getFPS() const noexceptvulk::FrameManagerinline
    getFramerateCString() const noexceptvulk::FrameManager
    getFramerateString() const noexceptvulk::FrameManager
    OnSecondCallback typedefvulk::FrameManager
    setOnSecondCallback(const OnSecondCallback &func) noexceptvulk::FrameManagerinline
    update() noexceptvulk::FrameManager
    FrameManager() + vulk::FrameManager
    FramerateStringBuffer + typedef + vulk::FrameManager
    getDeltaTime() + const noexcept + vulk::FrameManagerinline
    getFPS() + const noexcept + vulk::FrameManagerinline
    getFramerateString() + const noexcept + vulk::FrameManager
    getFramerateStringBuffer() + const noexcept + vulk::FrameManager
    OnSecondCallback + typedef + vulk::FrameManager
    setOnSecondCallback(const + OnSecondCallback &func) noexcept + vulk::FrameManagerinline
    update() + noexcept + vulk::FrameManager
    diff --git a/documentation/html/classvulk_1_1_frame_manager.html b/documentation/html/classvulk_1_1_frame_manager.html index f04d949..7fb5dea 100644 --- a/documentation/html/classvulk_1_1_frame_manager.html +++ b/documentation/html/classvulk_1_1_frame_manager.html @@ -62,33 +62,102 @@

    - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

     FrameManager ()
     
    void update () noexcept
     
    void setOnSecondCallback (const OnSecondCallback &func) noexcept
     
    auto getDeltaTime () const noexcept
     
    auto getFPS () const noexcept
     
    FramerateStringBuffer getFramerateCString () const noexcept
     
    std::string getFramerateString () const noexcept
     
     FrameManager + () +
     
    void update + () noexcept +
     
    void setOnSecondCallback + (const OnSecondCallback + &func) noexcept +
     
    auto getDeltaTime + () const noexcept +
     
    auto getFPS + () const noexcept +
     
    FramerateStringBuffer  + getFramerateStringBuffer + () const noexcept +
     
    std::string getFramerateString + () const noexcept +
     
    -

    Member Typedef Documentation

    - -

    ◆ FramerateStringBuffer

    + +

    Detailed Description

    +

    Class that manages a window's framerate, delta time (or frame time) and other time/frame + logics

    +
    +

    Member Typedef Documentation

    + +

    ◆ FramerateStringBuffer +

    -
    -
    - - - - -
    using vulk::FrameManager::FramerateStringBuffer = std::array<char, 16>
    +
    +
    + + + + +
    using vulk::FrameManager::FramerateStringBuffer + = std::array<char, 16> +
    +

    Static string buffer type for FPS counter as a string

    @@ -103,6 +172,7 @@

    +

    OnSecond event callback signature

    @@ -137,18 +207,25 @@

    auto vulk::FrameManager::getDeltaTime ( - ) - const + + ) + const - -inlinenoexcept + + inlinenoexcept -
    -
    +
    +

    Returns the frame time of the last update. Use this for framerate independent operations

    +
    +
    Returns
    +
    Frame time in seconds
    +
    + +

    ◆ getFPS()

    @@ -162,68 +239,94 @@

    auto vulk::FrameManager::getFPS ( - ) - const + + ) + const - -inlinenoexcept + + inlinenoexcept -
    -
    +
    +

    Returns the current framerate

    +
    +
    Returns
    +
    Frames per seconds unsigned integer
    +
    + +
    -     -

    ◆ getFramerateCString()

    + +

    ◆ getFramerateString() +

    -
    -
    - - - - - -
    - - - - - - - -
    vulk::FrameManager::FramerateStringBuffer vulk::FrameManager::getFramerateCString () const
    -     		-noexcept
    -
    +
    +
    + + + + + +
    + + + + + + + + +
    std::string vulk::FrameManager::getFramerateString() const
    +     		+ noexcept
    +
    +
    +

    Returns the framerate as a std::string

    +
    +
    Returns
    +
    Framerate as a string "XXX fps"
    +
    -
    -
    - -

    ◆ getFramerateString()

    +
    +
    + +

    ◆ getFramerateStringBuffer() +

    -
    -
    - - - - - -
    - - - - - - - -
    std::string vulk::FrameManager::getFramerateString () const
    -     		-noexcept
    -
    +
    +
    + + + + + +
    + + + + + + + + +
    vulk::FrameManager::FramerateStringBuffer + vulk::FrameManager::getFramerateStringBuffer + () const
    +     		+ noexcept
    +
    +
    +

    Returns the framerate as a string buffer

    +
    +
    Returns
    +
    Framerate string buffer
    +
    -
    +

    ◆ setOnSecondCallback()

    @@ -238,18 +341,32 @@

    void vulk::FrameManager::setOnSecondCallback ( const OnSecondCallback &  - func) - + func + ) + - -inlinenoexcept + + inlinenoexcept -

    -
    +
    +

    Add an optional callback to be called once every second

    +
    +
    Parameters
    +
    + + + + + +
    funcFunction callback to use. std::nullopt to reset
    +
    +
    + +

    ◆ update()

    @@ -273,6 +390,9 @@

    +

    Updates the frame manager. Call ONCE every frame. Already done in the Window + class

    diff --git a/documentation/html/classvulk_1_1_keyboard.html b/documentation/html/classvulk_1_1_keyboard.html index 9b146f6..eeca9fa 100644 --- a/documentation/html/classvulk_1_1_keyboard.html +++ b/documentation/html/classvulk_1_1_keyboard.html @@ -62,27 +62,60 @@  Destroy the Keyboard object. More...
      bool isKeyDown (vulk::Key key) const noexcept -  -void onKeyPressed (int scancode, int action) -  - - - - - + + + + + + + + + +

    -Static Public Member Functions

    static Keyboard * getKeyboard (GLFWwindow *window)
     Get the Keyboard object. More...
     
     
    void onKeyPressed + (int scancode, int action) +
     
    -

    Constructor & Destructor Documentation

    - -

    ◆ Keyboard()

    + + + + + + + + + + + + + + + +

    + Static Public Member Functions

    static Keyboard + *  + getKeyboard + (GLFWwindow *window) +
     Get the Keyboard object. More...
     
    + +

    Detailed Description

    +

    Keyboard class interface that can be + used to receive user input

    +
    +

    Constructor & Destructor Documentation

    + +

    ◆ Keyboard() +

    -
    -
    - - - - +
    - - +
    +
    +
    + + - - + + +
    + + diff --git a/documentation/html/classvulk_1_1_mouse.html b/documentation/html/classvulk_1_1_mouse.html index 85f9faf..b9ea2ab 100644 --- a/documentation/html/classvulk_1_1_mouse.html +++ b/documentation/html/classvulk_1_1_mouse.html @@ -59,27 +59,63 @@ - - - - -
    vulk::Keyboard::Keyboard ( GLFWwindow * 
     
     ~Mouse ()
     
    bool isButtonDown (vulk::Buttons button) const noexcept
     
    void onButtonPressed (int button, int action)
     
    - - - + + + + + + + + + + + + + +

    -Static Public Member Functions

    static Mouse * getMouse (GLFWwindow *window)
     
    bool isButtonDown + (vulk::Buttons button) const + noexcept +
     
    void onButtonPressed + (int button, int action) +
     
    -

    Constructor & Destructor Documentation

    - -

    ◆ Mouse()

    + + + + + + + + + + + +

    + Static Public Member Functions

    static Mouse + *  + getMouse + (GLFWwindow *window) +
     
    + +

    Detailed Description

    +

    Mouse class interface that can be used + to receive user input

    +
    +

    Constructor & Destructor Documentation

    + +

    ◆ Mouse() +

    -
    -
    - - - +
    - - +
    +
    +
    + + - +
    + + @@ -153,18 +189,36 @@

    bool vulk::Mouse::isButtonDown

    - - + + +
    vulk::Mouse::Mouse ( GLFWwindow * ( vulk::Buttons button) constbutton) const
    		-inlinenoexcept + inlinenoexcept
    -
    -
    +
    +

    Checks if the give mouse button is down

    +
    +
    Parameters
    +
    + + + + + +
    buttonMouse button
    +
    +
    +
    +
    Returns
    +
    true if it's currently pressed
    +
    + +

    ◆ onButtonPressed()

    diff --git a/documentation/html/dir_a065c5f60305fee3569f887679366939.html b/documentation/html/dir_a065c5f60305fee3569f887679366939.html index 5a9fa29..8e6bb0e 100644 --- a/documentation/html/dir_a065c5f60305fee3569f887679366939.html +++ b/documentation/html/dir_a065c5f60305fee3569f887679366939.html @@ -47,23 +47,67 @@
    - - - -

    -Directories

    directory  Contexts
     
    - - - - - - - - - - - + + + + + + + + + + +

    -Files

    file  Exceptions.cpp
     
    file  FrameManager.cpp
     
    file  Keyboard.cpp
     
    file  Mouse.cpp
     
    file  Objects.cpp
     

    + Directories

    directory  Contexts
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/documentation/html/dir_bbfa40afa4c57c6dadf08b9016d8766e.html b/documentation/html/dir_bbfa40afa4c57c6dadf08b9016d8766e.html index ff5f115..03602a6 100644 --- a/documentation/html/dir_bbfa40afa4c57c6dadf08b9016d8766e.html +++ b/documentation/html/dir_bbfa40afa4c57c6dadf08b9016d8766e.html @@ -47,25 +47,80 @@

    + Files

    file  Color.cpp
     
    file  Exceptions.cpp
     
    file  FrameManager.cpp +
     
    file  Keyboard.cpp
     
    file  Mouse.cpp
     
    file  Objects.cpp
     
    file  ScopedProfiler.cpp
     
    file  Shader.cpp
    - - - -

    -Directories

    directory  Contexts
     
    - - - - - - - - - - - - - + + + + + + + + + + +

    -Files

    file  ClassUtils.hpp [code]
     
    file  Exceptions.hpp [code]
     
    file  FrameManager.hpp [code]
     
    file  Keyboard.hpp [code]
     
    file  Mat3.hpp [code]
     
    file  Mouse.hpp [code]
     

    + Directories

    directory  Contexts
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/documentation/html/files.html b/documentation/html/files.html index 484b5e3..3a3a629 100644 --- a/documentation/html/files.html +++ b/documentation/html/files.html @@ -43,42 +43,267 @@
    Here is a list of all files with brief descriptions:
    -
    [detail level 12345]

    + Files

    file  ClassUtils.hpp [code]
     
    file  Color.hpp [code]
     
    file  Exceptions.hpp [code]
     
    file  FrameManager.hpp + [code]
     
    file  Keyboard.hpp [code]
     
    file  Mat3.hpp [code]
     
    file  Mouse.hpp [code]
     
    file  Objects.hpp [code]
     
    file  Rect.hpp [code]
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
     ▼ lib
     ▼ include
     ▼ Vulk
     ▼ Contexts
     ContextGLFW.hpp
     ContextVulkan.hpp
     ClassUtils.hpp
     Exceptions.hpp
     FrameManager.hpp
     Keyboard.hpp
     Mat3.hpp
     Mouse.hpp
     Objects.hpp
     Rect.hpp
     ScopedProfiler.hpp
     Shader.hpp
     Time.hpp
     Utils.hpp
     Vec2.hpp
     Vec3.hpp
     Window.hpp
     ▼ src
     ▼ Contexts
     ContextGLFW.cpp
     ContextVulkan.cpp
     Exceptions.cpp
     FrameManager.cpp
     Keyboard.cpp
     Mouse.cpp
     Objects.cpp
     ScopedProfiler.cpp
     Shader.cpp
     Utils.cpp
     Window.cpp
    +
    [detail level 12345] +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
     ▼ lib +
     ▼ include +
     ▼ Vulk +
     ▼ Contexts +
     ContextGLFW.hpp +
     ContextVulkan.hpp +
     ClassUtils.hpp +
     Color.hpp
     Exceptions.hpp +
     FrameManager.hpp +
     Keyboard.hpp +
     Mat3.hpp
     Mouse.hpp
     Objects.hpp +
     Rect.hpp
     ScopedProfiler.hpp +
     Shader.hpp +
     Time.hpp
     Utils.hpp
     Vec2.hpp
     Vec3.hpp
     Window.hpp +
     ▼ src +
     ▼ Contexts +
     ContextGLFW.cpp +
     ContextVulkan.cpp +
     Color.cpp
     Exceptions.cpp +
     FrameManager.cpp
     Keyboard.cpp
     Mouse.cpp
     Objects.cpp
     ScopedProfiler.cpp +
     Shader.cpp
     Utils.cpp
     Window.cpp
    diff --git a/documentation/html/functions.html b/documentation/html/functions.html index 9ca3f20..bc96699 100644 --- a/documentation/html/functions.html +++ b/documentation/html/functions.html @@ -39,21 +39,50 @@
    -
    Here is a list of all class members with links to the classes they belong to:
    - -

    - a -

      -
    • AttributeDescriptions : Vertex
      • -
    - - -

    - c -

    -  +   + +

    - a -

    + + + +

    - b -

    + + + +

    - c -

    + + + +

    - g -

    + + + +

    - h -

    + + + +

    - l -

    + + + +

    - m -

    + + + +

    - p -

    + + + +

    - r -

    + + + +

    - t -

    + + + +

    - v -

    + + + +

    - w -

    + + + +

    - x -

    + + + +

    - y -

    + + + +

    - z -

    +
    diff --git a/documentation/html/hierarchy.html b/documentation/html/hierarchy.html index 8a8be4c..d7043c1 100644 --- a/documentation/html/hierarchy.html +++ b/documentation/html/hierarchy.html @@ -43,28 +43,148 @@
    This inheritance list is sorted roughly, but not completely, alphabetically:
    -
    [detail level 12]
    - - - - - - - - - - - - - - - - - - - - -
     Cvulk::ContextGLFW
     Cvulk::ContextVulkan
     ▼Cstd::exception
     Cvulk::Exception
     Cvulk::FrameManager
     Cvulk::Keyboard
     ▼CLibraryException
     Cvulk::GLFWException
     Cvulk::VulkanException
     Cvulk::Mat3< T >
     Cvulk::Mouse
     Cvulk::Rect< T >
     Cvulk::utils::ScopedProfiler
     Cvulk::Shader
     CTypeChecker< T >
     CUniformBufferObject
     Cvulk::Vec2< T >
     Cvulk::Vec3< T >
     CVertex
     Cvulk::Window
    +
    [detail level 12] +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
     Cvulk::Color +
     Cvulk::ContextGLFW +
     Cvulk::ContextVulkan +
     ▼Cstd::exception
     Cvulk::Exception +
     Cvulk::FrameManager +
     Cvulk::Keyboard +
     ▼CLibraryException
     Cvulk::GLFWException
     Cvulk::VulkanException +
     Cvulk::Mat3< + T >The Mat3 + structure that can be use for mathematical purpose +
     Cvulk::Mouse
     Cvulk::Rect< + T >The Rect + structure that can be use for mathematical purpose or for setting hitboxes for example +
     Cvulk::utils::ScopedProfiler
     Cvulk::Shader +
     CTypeChecker< + T >
     CUniformBufferObject +
     Cvulk::Vec2< + T >The Vec2 + structure that can be use to create objects or do mathematical operations +
     Cvulk::Vec3< + T >The Vec3 + structure that can be use to create objects or do mathematical operations +
     CVertex
     Cvulk::Window +
    diff --git a/documentation/html/menudata.js b/documentation/html/menudata.js index ca7eddd..5617c1c 100644 --- a/documentation/html/menudata.js +++ b/documentation/html/menudata.js @@ -47,17 +47,18 @@ var menudata={children:[ {text:"Class Hierarchy",url:"hierarchy.html"}, {text:"Class Members",url:"functions.html",children:[ {text:"All",url:"functions.html",children:[ -{text:"a",url:"functions.html#index_a"}, -{text:"c",url:"functions.html#index_c"}, -{text:"d",url:"functions.html#index_d"}, -{text:"e",url:"functions.html#index_e"}, -{text:"f",url:"functions.html#index_f"}, -{text:"g",url:"functions.html#index_g"}, -{text:"h",url:"functions.html#index_h"}, -{text:"i",url:"functions.html#index_i"}, -{text:"k",url:"functions.html#index_k"}, -{text:"l",url:"functions.html#index_l"}, -{text:"m",url:"functions.html#index_m"}, + {text: "a", url: "functions.html#index_a"}, + {text: "b", url: "functions.html#index_b"}, + {text: "c", url: "functions.html#index_c"}, + {text: "d", url: "functions.html#index_d"}, + {text: "e", url: "functions.html#index_e"}, + {text: "f", url: "functions.html#index_f"}, + {text: "g", url: "functions.html#index_g"}, + {text: "h", url: "functions.html#index_h"}, + {text: "i", url: "functions.html#index_i"}, + {text: "k", url: "functions.html#index_k"}, + {text: "l", url: "functions.html#index_l"}, + {text: "m", url: "functions.html#index_m"}, {text:"n",url:"functions.html#index_n"}, {text:"o",url:"functions.html#index_o"}, {text:"p",url:"functions.html#index_p"}, @@ -80,19 +81,37 @@ var menudata={children:[ {text:"i",url:"functions_func.html#index_i"}, {text:"k",url:"functions_func.html#index_k"}, {text:"l",url:"functions_func.html#index_l"}, -{text:"m",url:"functions_func.html#index_m"}, -{text:"n",url:"functions_func.html#index_n"}, -{text:"o",url:"functions_func.html#index_o"}, -{text:"p",url:"functions_func.html#index_p"}, -{text:"r",url:"functions_func.html#index_r"}, -{text:"s",url:"functions_func.html#index_s"}, -{text:"u",url:"functions_func.html#index_u"}, -{text:"v",url:"functions_func.html#index_v"}, -{text:"w",url:"functions_func.html#index_w"}, -{text:"~",url:"functions_func.html#index__7E"}]}, -{text:"Variables",url:"functions_vars.html"}, -{text:"Typedefs",url:"functions_type.html"}, -{text:"Related Functions",url:"functions_rela.html"}]}]}, + {text: "m", url: "functions_func.html#index_m"}, + {text: "n", url: "functions_func.html#index_n"}, + {text: "o", url: "functions_func.html#index_o"}, + {text: "p", url: "functions_func.html#index_p"}, + {text: "r", url: "functions_func.html#index_r"}, + {text: "s", url: "functions_func.html#index_s"}, + {text: "u", url: "functions_func.html#index_u"}, + {text: "v", url: "functions_func.html#index_v"}, + {text: "w", url: "functions_func.html#index_w"}, + {text: "~", url: "functions_func.html#index__7E"}] +}, + { + text: "Variables", url: "functions_vars.html", children: [ + {text: "a", url: "functions_vars.html#index_a"}, + {text: "b", url: "functions_vars.html#index_b"}, + {text: "c", url: "functions_vars.html#index_c"}, + {text: "g", url: "functions_vars.html#index_g"}, + {text: "h", url: "functions_vars.html#index_h"}, + {text: "l", url: "functions_vars.html#index_l"}, + {text: "m", url: "functions_vars.html#index_m"}, + {text: "p", url: "functions_vars.html#index_p"}, + {text: "r", url: "functions_vars.html#index_r"}, + {text: "t", url: "functions_vars.html#index_t"}, + {text: "v", url: "functions_vars.html#index_v"}, + {text: "w", url: "functions_vars.html#index_w"}, + {text: "x", url: "functions_vars.html#index_x"}, + {text: "y", url: "functions_vars.html#index_y"}, + {text: "z", url: "functions_vars.html#index_z"}] + }, + {text: "Typedefs", url: "functions_type.html"}, + {text: "Related Functions", url: "functions_rela.html"}]}]}, {text:"Files",url:"files.html",children:[ {text:"File List",url:"files.html"}, {text:"File Members",url:"globals.html",children:[ diff --git a/documentation/html/namespaces.html b/documentation/html/namespaces.html index 146ba0d..311b804 100644 --- a/documentation/html/namespaces.html +++ b/documentation/html/namespaces.html @@ -43,25 +43,134 @@
    Here is a list of all namespaces with brief descriptions:
    -
    [detail level 123]
    - - - - - - - - - - - - - - - - - -
     ▼Nvulk
     ▼Nutils
     CScopedProfiler
     CContextGLFW
     CContextVulkan
     CException
     CFrameManager
     CGLFWException
     CKeyboard
     CMat3
     CMouse
     CRect
     CShader
     CVec2
     CVec3
     CVulkanException
     CWindow
    +
    [detail level 123] +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
     ▼Nvulk
     ▼Nutils
     CScopedProfiler
     CColor +
     CContextGLFW +
     CContextVulkan +
     CException +
     CFrameManager +
     CGLFWException
     CKeyboard
     CMat3 + The Mat3 + structure that can be use for mathematical purpose +
     CMouse +
     CRect + The Rect + structure that can be use for mathematical purpose or for setting hitboxes for example +
     CShader +
     CVec2 + The Vec2 + structure that can be use to create objects or do mathematical operations +
     CVec3 + The Vec3 + structure that can be use to create objects or do mathematical operations +
     CVulkanException +
     CWindow +
    diff --git a/documentation/html/namespacevulk.html b/documentation/html/namespacevulk.html index fe56c17..5bdd011 100644 --- a/documentation/html/namespacevulk.html +++ b/documentation/html/namespacevulk.html @@ -49,36 +49,111 @@
    - - - -

    -Namespaces

    namespace  utils
     
    - - - - - - - - - - - + + + + + + + + + + +

    -Classes

    class  ContextGLFW
     
    class  ContextVulkan
     
    class  Exception
     
    class  FrameManager
     
    class  GLFWException
     

    + Namespaces

    namespace  utils
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -355,6 +430,7 @@

    +

    Clock type alias

    @@ -369,6 +445,7 @@

    +

    Duration type alias

    @@ -439,6 +516,7 @@

    +

    Time point type alias

    @@ -574,6 +652,7 @@

    +

    Mouse buttons enum

    + Classes

    struct  Color
     
    class  ContextGLFW
     
    class  ContextVulkan +
     
    class  Exception +
     
    class  FrameManager
     
    class  GLFWException +
     
    class  Keyboard
     
    struct  Mat3
     The Mat3 + structure that can be use for mathematical purpose. More...
     
    class  Mouse
     
    struct  Rect
     The Rect + structure that can be use for mathematical purpose or for setting hitboxes for example. More...
     
    class  Shader
     
    struct  Vec2
     The Vec2 + structure that can be use to create objects or do mathematical operations. More...
     
    struct  Vec3
     The Vec3 + structure that can be use to create objects or do mathematical operations. More...
     
    class  VulkanException
     
    @@ -610,6 +689,7 @@

    +

    Keyboard key enum

    Enumerator
    BUTTON_1 
    BUTTON_2 
    diff --git a/documentation/html/structvulk_1_1_color-members.html b/documentation/html/structvulk_1_1_color-members.html new file mode 100644 index 0000000..973bd41 --- /dev/null +++ b/documentation/html/structvulk_1_1_color-members.html @@ -0,0 +1,222 @@ + + + + + + + + Vulk: Member List + + + + + + +
    +
    +
    Enumerator
    UNKNOWN 
    SPACE 
    + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + + + +
    +
    +
    vulk::Color Member List
    +
    +
    +
    + +

    This is the complete list of members for vulk::Color, + including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    a + vulk::Color
    b + vulk::Color
    Black + vulk::Colorstatic
    Blue + vulk::Colorstatic
    Color() + noexcept=default + vulk::Color
    Color(uint8_t + _r, uint8_t _g, uint8_t _b, uint8_t _a=255) noexcept + vulk::Colorinline
    Color(uint32_t + value) noexcept + vulk::Colorinlineexplicit
    Color(Color + &&) noexcept=default + vulk::Color
    Color(const + Color &) noexcept=default + vulk::Color
    CoolYellow + vulk::Colorstatic
    Cyan + vulk::Colorstatic
    g + vulk::Color
    Green + vulk::Colorstatic
    Grey + vulk::Colorstatic
    Magentavulk::Colorstatic
    operator<=>(const + Color &) const noexcept=default + vulk::Color
    operator=(Color + &&) noexcept=default + vulk::Color
    operator=(const + Color &) noexcept=default + vulk::Color
    r + vulk::Color
    Red + vulk::Colorstatic
    Transparent + vulk::Colorstatic
    value() + const noexcept + vulk::Colorinline
    White + vulk::Colorstatic
    Yellowvulk::Colorstatic
    +
    + +
    +
    + Generated by doxygen 1.9.2 +
    + + diff --git a/documentation/html/structvulk_1_1_color.html b/documentation/html/structvulk_1_1_color.html new file mode 100644 index 0000000..5033ef1 --- /dev/null +++ b/documentation/html/structvulk_1_1_color.html @@ -0,0 +1,1052 @@ + + + + + + + + Vulk: vulk::Color Struct Reference + + + + + + +
    +
    + + + + + + +
    +
    Vulk +
    +
    +
    + + + + + + + +
    +
    +
    + Public Member Functions | + Public Attributes | + Static Public Attributes | + List of all members
    +
    +
    vulk::Color Struct Reference
    +
    +
    +
    + +

    #include <Color.hpp>

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    + Public Member Functions

    constexpr Color + () noexcept=default +
     
    constexpr Color + (uint8_t _r, uint8_t _g, uint8_t _b, uint8_t _a=255) noexcept +
     
    constexpr Color + (uint32_t value) + noexcept +
     
    constexpr Color + (Color &&) noexcept=default +
     
    constexpr Color + (const Color &) noexcept=default +
     
    constexpr Color + &  + operator= + (Color &&) noexcept=default +
     
    constexpr Color + &  + operator= + (const Color &) noexcept=default +
     
    constexpr auto operator<=> + (const Color &) const noexcept=default +
     
    constexpr uint32_t value + () const noexcept +
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    + Public Attributes

    uint8_t r + {} +
     
    uint8_t g + {} +
     
    uint8_t b + {} +
     
    uint8_t a + {} +
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    + Static Public Attributes

    static Color  + Red + {255, 0, 0, 255} +
     
    static Color  + Green + {0, 255, 0, 255} +
     
    static Color  + Blue + {0, 0, 255, 255} +
     
    static Color  + Magenta + {255, 0, 255, 255} +
     
    static Color  + Cyan + {0, 255, 255, 255} +
     
    static Color  + Yellow + {255, 255, 0, 255} +
     
    static Color  + Black + {0, 0, 0, 255} +
     
    static Color  + White + {255, 255, 255, 255} +
     
    static Color  + Grey + {127, 127, 127, 255} +
     
    static Color  + Transparent + {0, 0, 0, 0} +
     
    static Color  + CoolYellow + {0xffca00ff} +
     
    + +

    Detailed Description

    +

    The color structure can be used to give a color to your objects, a tint to textures or any + other color related stuff

    +
    +

    Constructor & Destructor Documentation

    + +

    ◆ Color() + [1/5]

    + +
    +
    + + + + + +
    + + + + + + + + +
    constexpr vulk::Color::Color()
    +     		+ constexprdefaultnoexcept
    +
    +
    +

    Constructs a default color (Black transparent, 0x00000000)

    + +
    +
    + +

    ◆ Color() + [2/5]

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    constexpr vulk::Color::Color(uint8_t _r,
    uint8_t _g,
    uint8_t _b,
    uint8_t _a = 255 
    )
    +     		+ inlineconstexprnoexcept
    +
    +
    +

    Constructs a color using rgba components, [0;255]

    +
    +
    Parameters
    +
    + + + + + + + + + + + + + + + + + +
    _rRed component
    _gGreen component
    _bBlue component
    _aAlpha component (opacity)
    +
    +
    + +
    +
    + +

    ◆ Color() + [3/5]

    + +
    +
    + + + + + +
    + + + + + + + + + +
    constexpr vulk::Color::Color(uint32_t value)
    +     		+ inlineexplicitconstexprnoexcept +
    +
    +
    +

    Constructs a color from its hexadecimal value

    +
    +
    Parameters
    +
    + + + + + +
    valueHexadecimal value, format 0xRRGGBBAA with RR=Red, GG=Green, BB=Blue and AA=Alpha
    +
    +
    + +
    +
    + +

    ◆ Color() + [4/5]

    + +
    +
    + + + + + +
    + + + + + + + + + +
    constexpr vulk::Color::Color(Color &&  + )
    +     		+ constexprdefaultnoexcept
    +
    +
    + +
    +
    + +

    ◆ Color() + [5/5]

    + +
    +
    + + + + + +
    + + + + + + + + + +
    constexpr vulk::Color::Color(const Color + &  + )
    +     		+ constexprdefaultnoexcept
    +
    +
    + +
    +
    +

    Member Function Documentation

    + +

    ◆ operator<=>() +

    + +
    +
    + + + + + +
    + + + + + + + + + +
    constexpr auto vulk::Color::operator<=>(const Color + &  + ) const
    +     		+ constexprdefaultnoexcept
    +
    +
    + +
    +
    + +

    ◆ operator=() + [1/2]

    + +
    +
    + + + + + +
    + + + + + + + + + +
    constexpr Color + & vulk::Color::operator= + (Color &&  + )
    +     		+ constexprdefaultnoexcept
    +
    +
    + +
    +
    + +

    ◆ operator=() + [2/2]

    + +
    +
    + + + + + +
    + + + + + + + + + +
    constexpr Color + & vulk::Color::operator= + (const Color + &  + )
    +     		+ constexprdefaultnoexcept
    +
    +
    + +
    +
    + +

    ◆ value() +

    + +
    +
    + + + + + +
    + + + + + + + + +
    constexpr uint32_t vulk::Color::value() const
    +     		+ inlineconstexprnoexcept
    +
    +
    +

    Converts RGBA components to the integer value

    +
    +
    Returns
    +
    32 unsigned bit integer value representing the color
    +
    + +
    +
    +

    Member Data Documentation

    + +

    ◆ a +

    + +
    +
    + + + + +
    uint8_t vulk::Color::a {}
    +
    +
    + +
    +
    + +

    ◆ b +

    + +
    +
    + + + + +
    uint8_t vulk::Color::b {}
    +
    +
    + +
    +
    + +

    ◆ Black +

    + +
    +
    + + + + + +
    + + + + +
    vulk::Color + vulk::Color::Black {0, 0, 0, 255} +
    +     		+ static
    +
    +
    + +
    +
    + +

    ◆ Blue +

    + +
    +
    + + + + + +
    + + + + +
    vulk::Color + vulk::Color::Blue {0, 0, 255, 255} +
    +     		+ static
    +
    +
    + +
    +
    + +

    ◆ CoolYellow +

    + +
    +
    + + + + + +
    + + + + +
    vulk::Color + vulk::Color::CoolYellow {0xffca00ff} +
    +     		+ static
    +
    +
    + +
    +
    + +

    ◆ Cyan +

    + +
    +
    + + + + + +
    + + + + +
    vulk::Color + vulk::Color::Cyan {0, 255, 255, 255} +
    +     		+ static
    +
    +
    + +
    +
    + +

    ◆ g +

    + +
    +
    + + + + +
    uint8_t vulk::Color::g {}
    +
    +
    + +
    +
    + +

    ◆ Green +

    + +
    +
    + + + + + +
    + + + + +
    vulk::Color + vulk::Color::Green {0, 255, 0, 255} +
    +     		+ static
    +
    +
    + +
    +
    + +

    ◆ Grey +

    + +
    +
    + + + + + +
    + + + + +
    vulk::Color + vulk::Color::Grey {127, 127, 127, 255} +
    +     		+ static
    +
    +
    + +
    +
    + +

    ◆ Magenta +

    + +
    +
    + + + + + +
    + + + + +
    vulk::Color + vulk::Color::Magenta {255, 0, 255, 255} +
    +     		+ static
    +
    +
    + +
    +
    + +

    ◆ r +

    + +
    +
    + + + + +
    uint8_t vulk::Color::r {}
    +
    +
    + +
    +
    + +

    ◆ Red +

    + +
    +
    + + + + + +
    + + + + +
    vulk::Color + vulk::Color::Red {255, 0, 0, 255} +
    +     		+ static
    +
    +
    + +
    +
    + +

    ◆ Transparent +

    + +
    +
    + + + + + +
    + + + + +
    vulk::Color + vulk::Color::Transparent {0, 0, 0, 0} +
    +     		+ static
    +
    +
    + +
    +
    + +

    ◆ White +

    + +
    +
    + + + + + +
    + + + + +
    vulk::Color + vulk::Color::White {255, 255, 255, 255} +
    +     		+ static
    +
    +
    + +
    +
    + +

    ◆ Yellow +

    + +
    +
    + + + + + +
    + + + + +
    vulk::Color + vulk::Color::Yellow {255, 255, 0, 255} +
    +     		+ static
    +
    +
    + +
    +
    +
    + The documentation for this struct was generated from the following files: + +
    + +
    +
    + Generated by doxygen 1.9.2 +
    + + diff --git a/documentation/html/structvulk_1_1_mat3.html b/documentation/html/structvulk_1_1_mat3.html index 69aaa04..d0ab38d 100644 --- a/documentation/html/structvulk_1_1_mat3.html +++ b/documentation/html/structvulk_1_1_mat3.html @@ -52,15 +52,44 @@
    -

    #include <Mat3.hpp>

    - - - - - - - +

    The Mat3 structure that can be use + for mathematical purpose. + More...

    + +

    #include <Mat3.hpp>

    +

    -Public Member Functions

    constexpr Mat3 ()=default
     
    constexpr Mat3 (T value)
     
    constexpr Mat3 (const std::array< T, 9 > mat)
    + + + + + + + + + + + + + + + + + + + + + @@ -71,27 +100,59 @@

    + Public Member Functions

    constexpr Mat3 + ()=default +
     
    constexpr Mat3 + (T value) +
     
    constexpr Mat3 + (const std::array< T, 9 > mat) +
     
    constexpr Mat3 (T a1, T a2, T a3, T a4, T a5, T a6, T a7, T a8, T a9)
     
    constexpr T determinant () const noexcept
     
    - - - -

    -Public Attributes

    std::array< T, 9 > m
     
    - - - + + + + + + + + + +

    -Friends

    constexpr friend std::ostream & operator<< (std::ostream &os, const Mat3 &mat3) noexcept
     

    + Public Attributes

    std::array< T, 9 > m +
     
    -

    Constructor & Destructor Documentation

    - -

    ◆ Mat3() [1/4]

    + + + + + + + + + + + +

    + Friends

    constexpr friend std::ostream & operator<< + (std::ostream &os, const Mat3 &mat3) noexcept +
     
    + +

    Detailed Description

    +
    +
    template<typename T>
    + struct vulk::Mat3< T > +
    +

    The Mat3 structure that can be + use for mathematical purpose.

    +
    +

    Constructor & Destructor Documentation

    + +

    ◆ Mat3() + [1/4]

    -
    -
    -
    -template<typename T >
    - - - +
    +
    +
    +
    + template<typename T > +
    + + + - +
    @@ -270,7 +331,11 @@

    -
    Returns
    constexpr Mat3
    +
    +
    Returns
    +
    constexpr Mat3
    +
    @@ -326,7 +391,11 @@

    -
    Returns
    constexpr Mat3
    +
    +
    Returns
    +
    constexpr Mat3
    +
    diff --git a/documentation/html/structvulk_1_1_rect.html b/documentation/html/structvulk_1_1_rect.html index a05b9c7..a9fbe6d 100644 --- a/documentation/html/structvulk_1_1_rect.html +++ b/documentation/html/structvulk_1_1_rect.html @@ -52,15 +52,46 @@
    -

    #include <Rect.hpp>

    -

    constexpr vulk::Mat3< T >::Mat3
    - - - - - - +

    The Rect + structure that can be use for mathematical purpose or for setting hitboxes for example. + More...

    + +

    #include <Rect.hpp>

    +

    -Public Member Functions

    constexpr Rect ()=default
     
    constexpr Rect (T aLeft, T aTop, T aWidth, T aHeight)
     
    constexpr Rect (const Vec2< T > &pos, const Vec2< T > &size)
    + + + + + + + + + + + + + + + + + + + + + @@ -77,27 +108,65 @@ - - - - -

    + Public Member Functions

    constexpr Rect + ()=default +
     
    constexpr Rect + (T aLeft, T aTop, T aWidth, T aHeight) +
     
    constexpr Rect + (const Vec2< T > &pos, const Vec2< + T > &size) +
     
    constexpr bool operator== (const Rect< T > &right) const noexcept
     
     
    T top
     
    T width
     
    T height
     
    - - - + + + + + + + + + + + + + +

    -Friends

    constexpr friend std::ostream & operator<< (std::ostream &os, const Rect< T > &rect) noexcept
     
    T width +
     
    T height +
     
    -

    Constructor & Destructor Documentation

    - -

    ◆ Rect() [1/3]

    + + + + + + + + + + + +

    + Friends

    constexpr friend std::ostream & operator<< + (std::ostream &os, const Rect< T > &rect) + noexcept +
     
    + +

    Detailed Description

    +
    +
    template<typename T>
    + struct vulk::Rect< T > +
    +

    The Rect + structure that can be use for mathematical purpose or for setting hitboxes for example.

    +
    +

    Constructor & Destructor Documentation

    + +

    ◆ Rect() + [1/3]

    -
    -
    -
    -template<typename T >
    - - - - +
    +
    +
    +
    + template<typename T > +
    + + + +
    diff --git a/documentation/html/structvulk_1_1_vec2.html b/documentation/html/structvulk_1_1_vec2.html index 03c2b44..c3288f3 100644 --- a/documentation/html/structvulk_1_1_vec2.html +++ b/documentation/html/structvulk_1_1_vec2.html @@ -53,79 +53,221 @@
    -

    #include <Vec2.hpp>

    -
    constexpr vulk::Rect< T >::Rect
    - - - - +

    The Vec2 + structure that can be use to create objects or do mathematical operations. + More...

    + +

    #include <Vec2.hpp>

    +

    -Public Member Functions

    constexpr Vec2 ()=default
     
    constexpr Vec2 (T aX, T aY)
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    + Public Member Functions

    constexpr Vec2 + ()=default +
     The default constructor. More...
     
    constexpr Vec2 + (T aX, T aY) +
     Vec2 + constructor with two different parameters. More...
     
    constexpr Vec2 (T value)
     Vec2 + constructor with one parameter. More...
    +
     
    constexpr Vec2 operator- () const noexcept
     Return the negative vector. More...
     
    constexpr Vec2 & operator+= (const Vec2 &rhs)
     Addition between two Vec2. + More...
     
    constexpr Vec2 & operator-= (const Vec2 &rhs)
     Substraction between two Vec2. + More...
     
    constexpr Vec2 & operator*= (const T value)
     Multiplication between a Vec2 + and a value. More...
     
    constexpr Vec2 & operator/= (const T value)
     Division between a Vec2 + and a value. More...
     
    constexpr T lengthSquared () const noexcept
     Return the length squared of the Vec2. + More...
     
    constexpr T length () const noexcept
     Reutrn the lenth of the Vec2. + More...
     
    constexpr Vec2 normalized () const noexcept
     Return the normalized version of the Vec2. + More...
     
    + + + + + + + +

    Static Public Member Functions

    constexpr static T dot (const Vec2 &lhs, const Vec2 &rhs) noexcept
     Return the dot product of two Vec2. + More...
     
    constexpr static T cross (const Vec2 &lhs, const Vec2 &rhs) noexcept
     Return the cross product of two Vec2. + More...
     
    - - - - -

    Public Attributes

    T x
     
    T y
     
    - - - + + + + + + + + + + + + + +

    -Friends

    constexpr friend std::ostream & operator<< (std::ostream &os, const Vec2 &Vec2) noexcept
     
    T x +
     
    T y +
     
    -

    Constructor & Destructor Documentation

    - -

    ◆ Vec2() [1/3]

    - -
    -
    -
    -template<typename T >
    - - - + + +
    + + + + + + + + + + + +

    + Friends

    constexpr friend std::ostream & operator<< + (std::ostream &os, const Vec2 &Vec2) + noexcept +
     
    + +

    Detailed Description

    +
    +
    template<typename T>
    + struct vulk::Vec2< T > +
    +

    The Vec2 + structure that can be use to create objects or do mathematical operations.

    +
    +

    Constructor & Destructor Documentation

    + +

    ◆ Vec2() + [1/3]

    + +
    +
    +
    + template<typename T > +
    + + + - - -
    - +
    constexpr vulk::Vec2< T >::Vec2 ( )
    -     		-constexprdefault
    -
    +
    		+ constexprdefault
    +
    +
    -
    +

    The default constructor.

    + +

    ◆ Vec2() [2/3]

    @@ -153,17 +295,38 @@

    -inlineconstexpr

    		+ inlineconstexpr
    -
    -
    +
    + +

    Vec2 + constructor with two different parameters.

    +
    +
    Parameters
    +
    + + + + + + + + + +
    aXx value of the vector
    aYy value of the vector
    +
    +
    + +

    ◆ Vec2() [3/3]

    @@ -181,17 +344,34 @@

    T 

    		 value)
    		-inlineexplicitconstexpr + inlineexplicitconstexpr
    -
    -
    +
    + +

    Vec2 + constructor with one parameter.

    +
    +
    Parameters
    +
    + + + + + +
    valuex and y will both take this value
    +
    +
    + +

    Member Function Documentation

    @@ -219,26 +399,44 @@

    -inlinestaticconstexprnoexcept

    		+ inlinestaticconstexprnoexcept
    -
    -
    Parameters
    - - - -
    lhs
    rhs
    -
    -
    -
    Returns
    constexpr T
    -
    +
    + +

    Return the cross product of two Vec2. +

    +
    +
    Parameters
    +
    + + + + + + + + + +
    lhs
    rhs
    +
    +
    +
    +
    Returns
    +
    constexpr T
    +
    + +

    ◆ dot()

    @@ -265,26 +463,44 @@

    -inlinestaticconstexprnoexcept

    		+ inlinestaticconstexprnoexcept
    -
    -
    Parameters
    - - - -
    lhs
    rhs
    -
    -
    -
    Returns
    constexpr T
    -
    +
    + +

    Return the dot product of two Vec2. +

    +
    +
    Parameters
    +
    + + + + + + + + + +
    lhs
    rhs
    +
    +
    +
    +
    Returns
    +
    constexpr T
    +
    + +

    ◆ length()

    @@ -300,19 +516,29 @@

    constexpr T vulk::Vec2< T >::length

    		() const) const
    		-inlineconstexprnoexcept + inlineconstexprnoexcept
    -
    -
    Returns
    constexpr T
    -
    +
    + +

    Reutrn the lenth of the Vec2. +

    +
    +
    Returns
    +
    constexpr T
    +
    + +

    ◆ lengthSquared()

    @@ -328,19 +554,29 @@

    constexpr T vulk::Vec2< T >::lengthSquared ( - ) - const + + ) + const - -inlineconstexprnoexcept + + inlineconstexprnoexcept -
    -
    Returns
    constexpr T
    -
    +
    + +

    Return the length squared of the Vec2. +

    +
    +
    Returns
    +
    constexpr T
    +
    + +

    ◆ normalized()

    @@ -356,19 +592,31 @@

    constexpr Vec2 vulk::Vec2< T >::normalized ( - ) - const + + ) + const - -inlineconstexprnoexcept + + inlineconstexprnoexcept -
    -
    Returns
    constexpr Vec2
    -
    +
    + +

    Return the normalized version of the Vec2. +

    +
    +
    Returns
    +
    constexpr Vec2 +
    +
    + +

    ◆ operator*=()

    @@ -385,25 +633,41 @@

    constexpr Vec2 & vulk::Vec2< T >::operator*= ( const T  - value) - + value + ) + - -inlineconstexpr + + inlineconstexpr -
    -
    Parameters
    - - -
    value
    -
    -
    -
    Returns
    constexpr Vec2&
    -
    +
    + +

    Multiplication between a Vec2 + and a value.

    +
    +
    Parameters
    +
    + + + + + +
    value
    +
    +
    +
    +
    Returns
    +
    constexpr Vec2& +
    +
    + +

    ◆ operator+=()

    @@ -420,25 +684,41 @@

    constexpr Vec2 & vulk::Vec2< T >::operator+= ( const Vec2< T > &  - rhs) - + rhs + ) + - -inlineconstexpr + + inlineconstexpr -
    -
    Parameters
    - - -
    rhs
    -
    -
    -
    Returns
    constexpr Vec2&
    -
    +
    + +

    Addition between two Vec2. +

    +
    +
    Parameters
    +
    + + + + + +
    rhs
    +
    +
    +
    +
    Returns
    +
    constexpr Vec2& +
    +
    + +

    ◆ operator-()

    @@ -454,19 +734,29 @@

    constexpr Vec2 vulk::Vec2< T >::operator- ( - ) - const + + ) + const - -inlineconstexprnoexcept + + inlineconstexprnoexcept -
    -
    Returns
    constexpr Vec2
    -
    +
    + +

    Return the negative vector.

    +
    +
    Returns
    +
    constexpr Vec2 +
    +
    + +

    ◆ operator-=()

    @@ -483,25 +773,41 @@

    constexpr Vec2 & vulk::Vec2< T >::operator-= ( const Vec2< T > &  - rhs) - + rhs + ) + - -inlineconstexpr + + inlineconstexpr -
    -
    Parameters
    - - -
    rhs
    -
    -
    -
    Returns
    constexpr Vec2&
    -
    +
    + +

    Substraction between two Vec2. +

    +
    +
    Parameters
    +
    + + + + + +
    rhs
    +
    +
    +
    +
    Returns
    +
    constexpr Vec2& +
    +
    + +

    ◆ operator/=()

    @@ -518,25 +824,41 @@

    constexpr Vec2 & vulk::Vec2< T >::operator/= ( const T  - value) - + value + ) + - -inlineconstexpr + + inlineconstexpr -
    -
    Parameters
    - - -
    value
    -
    -
    -
    Returns
    constexpr Vec2&
    -
    +
    + +

    Division between a Vec2 + and a value.

    +
    +
    Parameters
    +
    + + + + + +
    value
    +
    +
    +
    +
    Returns
    +
    constexpr Vec2& +
    +
    + +

    Friends And Related Function Documentation

    @@ -577,7 +899,12 @@

    Parameters
    - + + + +
    os
    Vec2
    Vec2 +
    diff --git a/documentation/html/structvulk_1_1_vec3.html b/documentation/html/structvulk_1_1_vec3.html index 5e2f848..bbcf51a 100644 --- a/documentation/html/structvulk_1_1_vec3.html +++ b/documentation/html/structvulk_1_1_vec3.html @@ -53,81 +53,219 @@
    -

    #include <Vec3.hpp>

    - - - - - +

    The Vec3 + structure that can be use to create objects or do mathematical operations. + More...

    + +

    #include <Vec3.hpp>

    +

    -Public Member Functions

    constexpr Vec3 ()=default
     
    constexpr Vec3 (T aX, T aY, T aZ)
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    + Public Member Functions

    constexpr Vec3 + ()=default +
     The default constructor. More...
     
    constexpr Vec3 + (T aX, T aY, T aZ) +
     Vec3 + constructor with three different parameters. More...
     
    constexpr Vec3 (T value)
     Vec3 + constructor with one parameter. More...
    +
     
    constexpr Vec3 operator- () const noexcept
     Return the negative vector. More...
     
    constexpr Vec3 & operator+= (const Vec3 &rhs)
     Addition betwen two Vec3. + More...
     
    constexpr Vec3 & operator-= (const Vec3 &rhs)
     Substraction between two Vec3. + More...
     
    constexpr Vec3 & operator*= (const T value)
     Multiplication between a Vec3 + and a value. More...
     
    constexpr Vec3 & operator/= (const T value)
     Division between a Vec3 + and a value. More...
     
    constexpr T lengthSquared () const noexcept
     Return the length squared of the Vec3. + More...
     
    constexpr T length () const noexcept
     Return the length of the Vec3. + More...
     
    constexpr Vec3 normalized () const noexcept
     Return the normalized version of the vector. More...
     
    + + + + + + + +

    Static Public Member Functions

    constexpr static T dot (const Vec3 &lhs, const Vec3 &rhs) noexcept
     Return the dot product of two Vec3. + More...
     
    constexpr static Vec3 cross (const Vec3 &lhs, const Vec3 &rhs) noexcept
     Return the cross product of two vectors. More...
     
    - - - - -

    Public Attributes

    T x
     
    T y
     
    T z
     
    - - - + + + + + + + + + + + + + +

    -Friends

    constexpr friend std::ostream & operator<< (std::ostream &os, const Vec3 &vec3) noexcept
     
    T y +
     
    T z +
     
    -

    Constructor & Destructor Documentation

    - -

    ◆ Vec3() [1/3]

    - -
    -
    -
    -template<typename T >
    - - - + + +
    + + + + + + + + + + + +

    + Friends

    constexpr friend std::ostream & operator<< + (std::ostream &os, const Vec3 &vec3) noexcept +
     
    + +

    Detailed Description

    +
    +
    template<typename T>
    + struct vulk::Vec3< T > +
    +

    The Vec3 + structure that can be use to create objects or do mathematical operations.

    +
    +

    Constructor & Destructor Documentation

    + +

    ◆ Vec3() + [1/3]

    + +
    +
    +
    + template<typename T > +
    + + + - - -
    - +
    constexpr vulk::Vec3< T >::Vec3 ( )
    -     		-constexprdefault
    -
    +
    		+ constexprdefault
    +
    +
    -
    +

    The default constructor.

    + +

    ◆ Vec3() [2/3]

    @@ -161,17 +299,42 @@

    -inlineconstexpr + + inlineconstexpr -
    -
    +
    + +

    Vec3 + constructor with three different parameters.

    +
    +
    Parameters
    +
    + + + + + + + + + + + + + +
    aXx value of the vector
    aYy value of the vector
    aZz value of the vector
    +
    +
    + +

    ◆ Vec3() [3/3]

    @@ -189,17 +352,34 @@

    T  value) - + - -inlineexplicitconstexpr + + inlineexplicitconstexpr -
    -
    +
    + +

    Vec3 + constructor with one parameter.

    +
    +
    Parameters
    +
    + + + + + +
    valuex, y and z will take this value
    +
    +
    + +

    Member Function Documentation

    @@ -227,26 +407,44 @@

    -inlinestaticconstexprnoexcept + + inlinestaticconstexprnoexcept -
    -
    Parameters
    - - - -
    lhs
    rhs
    -
    -
    -
    Returns
    constexpr Vec3
    -
    +
    + +

    Return the cross product of two vectors.

    +
    +
    Parameters
    +
    + + + + + + + + + +
    lhs
    rhs
    +
    +
    +
    +
    Returns
    +
    constexpr Vec3 +
    +
    + +

    ◆ dot()

    @@ -273,26 +471,44 @@

    -inlinestaticconstexprnoexcept + + inlinestaticconstexprnoexcept -
    -
    Parameters
    - - - -
    lhs
    rhs
    -
    -
    -
    Returns
    constexpr T
    -
    +
    + +

    Return the dot product of two Vec3. +

    +
    +
    Parameters
    +
    + + + + + + + + + +
    lhs
    rhs
    +
    +
    +
    +
    Returns
    +
    constexpr T
    +
    + +

    ◆ length()

    @@ -308,19 +524,29 @@

    constexpr T vulk::Vec3< T >::length ( - ) - const + + ) + const - -inlineconstexprnoexcept + + inlineconstexprnoexcept -
    -
    Returns
    constexpr T
    -
    +
    + +

    Return the length of the Vec3. +

    +
    +
    Returns
    +
    constexpr T
    +
    + +

    ◆ lengthSquared()

    @@ -336,19 +562,29 @@

    constexpr T vulk::Vec3< T >::lengthSquared ( - ) - const + + ) + const - -inlineconstexprnoexcept + + inlineconstexprnoexcept -
    -
    Returns
    constexpr T
    -
    +
    + +

    Return the length squared of the Vec3. +

    +
    +
    Returns
    +
    constexpr T
    +
    + +

    ◆ normalized()

    @@ -364,19 +600,29 @@

    constexpr Vec3 vulk::Vec3< T >::normalized ( - ) - const + + ) + const - -inlineconstexprnoexcept + + inlineconstexprnoexcept -
    -
    Returns
    constexpr Vec3
    -
    +
    + +

    Return the normalized version of the vector.

    +
    +
    Returns
    +
    constexpr Vec3 +
    +
    + +

    ◆ operator*=()

    @@ -393,25 +639,41 @@

    constexpr Vec3 & vulk::Vec3< T >::operator*= ( const T  - value) - + value + ) + - -inlineconstexpr + + inlineconstexpr -
    -
    Parameters
    - - -
    value
    -
    -
    -
    Returns
    constexpr Vec3&
    -
    +
    + +

    Multiplication between a Vec3 + and a value.

    +
    +
    Parameters
    +
    + + + + + +
    value
    +
    +
    +
    +
    Returns
    +
    constexpr Vec3& +
    +
    + +

    ◆ operator+=()

    @@ -428,25 +690,41 @@

    constexpr Vec3 & vulk::Vec3< T >::operator+= ( const Vec3< T > &  - rhs) - + rhs + ) + - -inlineconstexpr + + inlineconstexpr -
    -
    Parameters
    - - -
    rhs
    -
    -
    -
    Returns
    constexpr Vec3&
    -
    +
    + +

    Addition betwen two Vec3. +

    +
    +
    Parameters
    +
    + + + + + +
    rhs
    +
    +
    +
    +
    Returns
    +
    constexpr Vec3& +
    +
    + +

    ◆ operator-()

    @@ -462,19 +740,29 @@

    constexpr Vec3 vulk::Vec3< T >::operator- ( - ) - const + + ) + const - -inlineconstexprnoexcept + + inlineconstexprnoexcept -
    -
    Returns
    constexpr Vec3
    -
    +
    + +

    Return the negative vector.

    +
    +
    Returns
    +
    constexpr Vec3 +
    +
    + +

    ◆ operator-=()

    @@ -491,25 +779,41 @@

    constexpr Vec3 & vulk::Vec3< T >::operator-= ( const Vec3< T > &  - rhs) - + rhs + ) + - -inlineconstexpr + + inlineconstexpr -
    -
    Parameters
    - - -
    rhs
    -
    -
    -
    Returns
    constexpr Vec3&
    -
    +
    + +

    Substraction between two Vec3. +

    +
    +
    Parameters
    +
    + + + + + +
    rhs
    +
    +
    +
    +
    Returns
    +
    constexpr Vec3& +
    +
    + +

    ◆ operator/=()

    @@ -526,25 +830,41 @@

    constexpr Vec3 & vulk::Vec3< T >::operator/= ( const T  - value) - + value + ) + - -inlineconstexpr + + inlineconstexpr -
    -
    Parameters
    - - -
    value
    -
    -
    -
    Returns
    constexpr Vec3&
    -
    +
    + +

    Division between a Vec3 + and a value.

    +
    +
    Parameters
    +
    + + + + + +
    value
    +
    +
    +
    +
    Returns
    +
    constexpr Vec3& +
    +
    + +

    Friends And Related Function Documentation