Merge pull request #38 from CapsCollective/feature/text-rendering

Added 3D text rendering capabilities

Author: Raelr

.github/workflows/windows.yml

@@ -20,7 +20,7 @@ jobs:
     - uses: actions/checkout@v2
 
     - name: perform setup
-      run: ./scripts/setup.bat
+      run: ./scripts/Setup.ps1
 
     - name: build all targets
       run: mingw32-make

.gitmodules

@@ -37,3 +37,12 @@
 [submodule "vendor/vulkan/Vulkan-ValidationLayers"]
 	path = vendor/vulkan/Vulkan-ValidationLayers
 	url = https://github.com/KhronosGroup/Vulkan-ValidationLayers.git
+[submodule "vendor/zlib"]
+	path = vendor/zlib
+	url = https://github.com/madler/zlib.git
+[submodule "vendor/libpng"]
+	path = vendor/libpng
+	url = https://github.com/glennrp/libpng.git
+[submodule "vendor/freetype"]
+	path = vendor/freetype
+	url = https://github.com/freetype/freetype.git

README.md

@@ -89,7 +89,7 @@ $ sudo apt install libasound2-dev mesa-common-dev libx11-dev libxrandr-dev libxi
     ```
     ```console
     // Windows
-    > ./scripts/setup.bat
+    > ./scripts/Setup.ps1
     ```
 
 3. This should install all required dependencies. Once completed a `.env` file will be generated with all required variables. If the build is completed with no issue then you can proceed to build the project.
@@ -104,14 +104,14 @@ $ ./scripts/setup.sh --include-validation-layers
 ```
 ```console
 // Windows
-> ./scripts/setup.bat --include-validation-layers
+> ./scripts/Setup.ps1 -Include_Validation_Layers
 ```
 
 **NOTE**: Building with this option can take some time to complete. Please be patient while the project builds the required validation layers.
 
 ### Building the Project
 
-Assuming all dependencies have been satisfied, the project can be build using the following command:
+Assuming all dependencies have been satisfied, the project can be built using the following command:
 
 ```console
 // Linux and macOS

engine/render/Makefile

@@ -14,6 +14,8 @@ renderSources := $(call rwildcard,$(renderSrcDir)/,*.cpp)
 renderObjects := $(call findobjs,$(renderSrcDir),$(renderBinDir),$(renderSources))
 renderDepends := $(patsubst %.o, %.d, $(call rwildcard,$(renderBinDir)/,*.o))
 renderBuildDir := $(renderBinDir)/build
+renderLibs := $(vendorDir)/glfw/build/src/libglfw3.a $(vendorDir)/zlib/build/lib/libz.a \
+$(vendorDir)/libpng/build/libpng.a $(vendorDir)/freetype/build/libfreetype.a
 
 # Set shader build vars
 vertSources := $(call rwildcard,assets/shaders,*.vert)
@@ -23,44 +25,31 @@ fragObjects := $(patsubst %.frag,$(renderBuildDir)/%.frag.spv,$(fragSources))
 
 linkFlags += -l utils
 
-# Set build vars
-ifeq ($(platform), windows)
-    volkDefines = VK_USE_PLATFORM_WIN32_KHR
-    glslangValidator := $(vendorDir)\glslang\build\install\bin\glslangValidator.exe
-else ifeq ($(platform), linux)
-	volkDefines = VK_USE_PLATFORM_XLIB_KHR
-	glslangValidator := $(vendorDir)/glslang/build/install/bin/glslangValidator
-else ifeq ($(platform), macos)
-	volkDefines = VK_USE_PLATFORM_MACOS_MVK
-	glslangValidator := $(vendorDir)/glslang/build/install/bin/glslangValidator
-endif
 compileFlags += -I $(vendorDir)/vulkan/include -I $(vendorDir)/glfw/include -I $(vendorDir)/glm \
-				-I $(vendorDir)/tinyobjloader -I $(vendorDir)/stb_image
+				-I $(vendorDir)/tinyobjloader -I $(vendorDir)/stb_image -I $(vendorDir)/zlib/build/include \
+				-I $(vendorDir)/libpng -I $(vendorDir)/include/freetype
 
 .PHONY: all vulkan-libs
 
 all: $(renderLib) $(vertObjects) $(fragObjects) vulkan-libs
 
 # Build the static library
 $(renderLib): $(renderObjects)
-	$(MKDIR) $(call platformpth, $(libDir))
 	$(RM) $(call platformpth, $(renderLib))
-	$(call COPY,$(vendorDir)/glfw/src,$(libDir),libglfw3.a)
-	mv $(call platformpth,$(libDir)/libglfw3.a) $(call platformpth,$(libDir)/librender.a)
-	ar -rcs $(renderLib) $(renderObjects) 
+	$(call COMBINE_LIBS, $(renderLibs), $(renderObjects), $(libDir), render)
 
 # Add all rules from dependency files
 -include $(renderDepends)
 
 # Compile object files to the bin directory
 $(renderBinDir)/%.o: $(renderSrcDir)/%.cpp
 	$(MKDIR) $(call platformpth, $(@D))
-	$(CXX) -MMD -MP -c $(compileFlags) -I $(engineDir) $< -o $@ $(CXXFLAGS) -D$(volkDefines)
+	$(CXX) -MMD -MP -c $(compileFlags) -I $(engineDir) $< -o $@ $(CXXFLAGS) -DVK_USE_PLATFORM_$(VOLK_OS)
 
 # Compile shaders to the build directory
 $(renderBuildDir)/assets/shaders/%.spv: $(renderSrcDir)/assets/shaders/%
 	$(MKDIR) $(call platformpth, $(@D))
-	$(call platformpth,$(glslangValidator)) $< -V -o $@
+	$(call platformpth,$(vendorDir)/glslang/build/StandAlone/glslangValidator$(EXE_NAME)) $< -V -o $@
 
 # Copy Vulkan libraries to the build directory
 vulkan-libs:

engine/render/assets/shaders/text2D.frag

@@ -0,0 +1,22 @@
+//
+//  Copyright (c) 2022 Jonathan Moallem (@J-Mo63) & Aryeh Zinn (@Raelr)
+//
+//  This code is released under an unmodified zlib license.
+//  For conditions of distribution and use, please see:
+//      https://opensource.org/licenses/Zlib
+//
+
+#version 460
+
+layout (location = 0) in vec4 fragColour;
+layout (location = 1) in vec2 uv;
+layout (location = 2) in flat uint texId;
+
+layout (location = 0) out vec4 outColour;
+
+layout(binding = 1) uniform sampler2D tex[16];
+
+void main() {
+    vec4 sampled = vec4(1.0, 1.0, 1.0, texture(tex[texId], uv).r);
+    outColour = fragColour * sampled;
+}

engine/render/assets/shaders/text2D.vert

@@ -0,0 +1,59 @@
+//
+//  Copyright (c) 2022 Jonathan Moallem (@J-Mo63) & Aryeh Zinn (@Raelr)
+//
+//  This code is released under an unmodified zlib license.
+//  For conditions of distribution and use, please see:
+//      https://opensource.org/licenses/Zlib
+//
+
+#version 450
+
+// Per instance data
+layout(location = 0) in mat4 transform;
+layout(location = 4) in vec4 texData; // Stores the minimum x and y values for the glyph in the texture + the glyph's dimensions in the texture
+layout(location = 5) in vec4 colour;
+layout(location = 6) in vec4 coordinates; // stores x and y coordinates in space + the glyph's dimensions in space
+
+layout(location = 0) out vec4 fragColor;
+layout(location = 1) out vec2 outUv;
+layout(location = 2) out uint outTexId;
+
+layout (push_constant) uniform TextureData
+{
+    uint textureIndex;
+} textureData;
+
+struct CameraData
+{
+    mat4 projectionMatrix;
+    mat4 viewMatrix;
+};
+
+layout (binding = 0) uniform GlobalData {
+    CameraData cameraData;
+} globalData;
+
+CameraData camera = globalData.cameraData;
+
+void main() {
+    vec2 coords = vec2(texData.xy);
+    vec2 dimensions = vec2(texData.zw);
+
+    // Find the UV based on the vertex index - max values = coordinate + dimension
+    float uvx = (float(gl_VertexIndex == 0 || gl_VertexIndex == 1) * (texData.x + texData.z))
+        + (float(gl_VertexIndex == 2 || gl_VertexIndex == 3) * (texData.x));
+    float uvy = (float(gl_VertexIndex == 0 || gl_VertexIndex == 3) * (texData.y + texData.w))
+        + (float(gl_VertexIndex == 1 || gl_VertexIndex == 2) * (texData.y));
+
+    // Find the vertex position based off the vertex index - max values = coordinate + dimension
+    float posX = (float(gl_VertexIndex == 0 || gl_VertexIndex == 1) * (coordinates.x + coordinates.z))
+        + (float(gl_VertexIndex == 2 || gl_VertexIndex == 3) * coordinates.x);
+    float posY = (float(gl_VertexIndex == 0 || gl_VertexIndex == 3) * (coordinates.y + coordinates.w))
+        + (float(gl_VertexIndex == 1 || gl_VertexIndex == 2) * coordinates.y);
+
+    gl_Position = camera.projectionMatrix * camera.viewMatrix * transform * vec4(posX, posY, 0, 1.0);
+
+    fragColor = colour;
+    outUv = vec2(uvx, uvy);
+    outTexId = textureData.textureIndex;
+}

engine/render/assets/shaders/texturedQuad.frag

@@ -9,6 +9,6 @@ layout (location = 0) out vec4 outColour;
 layout(binding = 1) uniform sampler2D tex[16];
 
 void main() {
-    vec4 sampled = vec4(texture(tex[texId], uv));
-    outColour = vec4(fragColour, 1.0) * sampled;
+    vec3 sampled = texture(tex[texId], uv).rgb;
+    outColour = vec4(fragColour * sampled, 1.0);
 }

engine/render/renderer/Renderer.cpp

@@ -10,7 +10,9 @@
 
 #include "Renderer.h"
 
+#include "platform/vulkan/Font.h"
 #include "platform/vulkan/utils/Types.h"
+#include "statics/Statics.h"
 
 namespace Siege
 {
@@ -20,6 +22,8 @@ uint32_t Renderer::currentFrameIndex = 0;
 
 Renderer::Renderer(Window& window) : window {window}
 {
+    Statics::Initialise();
+
     if (instance == nullptr) instance = this;
 
     auto extent = window.GetExtent();
@@ -48,14 +52,15 @@ Renderer::~Renderer()
     DescriptorPool::DestroyPool();
     Renderer3D::DestroyRenderer3D();
     Renderer2D::DestroyRenderer2D();
+    Statics::Free();
 }
 
 void Renderer::DrawFrame()
 {
     Renderer2D::GlobalData global2DData = {projection};
 
-    Renderer3D::Render(currentFrameIndex, commandBuffers, projection);
     Renderer2D::Render(commandBuffers, global2DData, currentFrameIndex);
+    Renderer3D::Render(currentFrameIndex, commandBuffers, projection);
 }
 
 void Renderer::RecreateSwapChain()
@@ -113,6 +118,7 @@ bool Renderer::StartFrame()
 void Renderer::EndFrame()
 {
     Renderer2D::Update();
+    Renderer3D::Update();
 
     CC_ASSERT(isFrameStarted, "Can't end frame while frame is not in progress!")
 

engine/render/renderer/platform/vulkan/Config.h

@@ -12,14 +12,21 @@
 #include <utils/collections/StackArray.h>
 #include <volk/volk.h>
 
+#ifdef __APPLE__
+#define EXTENSIONS_COUNT 3
+#define OS_EXTENSIONS , "VK_KHR_portability_subset"
+#else
+#define EXTENSIONS_COUNT 2
+#define OS_EXTENSIONS
+#endif
+
 namespace Siege::Vulkan
 {
 class Config
 {
 public:
 
     static constexpr uint32_t VALIDATION_LAYERS_COUNT = 1;
-    static constexpr uint32_t EXTENSIONS_COUNT = 2;
 
     /**
      * An array storing all required validation layers (if enabled).
@@ -33,7 +40,7 @@ class Config
      **/
     static constexpr SArray<const char*, EXTENSIONS_COUNT> deviceExtensions = {
         VK_KHR_SWAPCHAIN_EXTENSION_NAME,
-        VK_KHR_SHADER_DRAW_PARAMETERS_EXTENSION_NAME};
+        VK_KHR_SHADER_DRAW_PARAMETERS_EXTENSION_NAME OS_EXTENSIONS};
 };
 } // namespace Siege::Vulkan