Updated up to chapter 17

Author: lwjglgamedev

README.md

@@ -6,7 +6,7 @@ This [online book](bookcontents/) will introduce the main concepts required to w
 
 We will use [LWJGL](http://www.lwjgl.org/) as the Java library which provides the required bindings to use Vulkan and any other required APIs. This book is the result of my self learning language, that I think it may help the community.
 
-![Sample screen shot](./bookcontents/chapter-13/rc13-screen-shot.png)
+![Sample screen shot](./bookcontents/chapter-17/rc17-screen-shot.png)
 
 > [!NOTE]
 > This is a new version which tries to use modern Vulkan features, such us:

bookcontents/README.md

@@ -0,0 +1,22 @@
+# Table of Contents
+
+The book is structured in the following chapters:
+
+- [Chapter 00](chapter-00/chapter-00.md): Vulkan introduction and book pre-requisites.
+- [Chapter 01](chapter-01/chapter-01.md): Describes the basic scaffolding code to support rendering.
+- [Chapter 02](chapter-02/chapter-02.md): We start with the first Vulkan pieces of code that will create a Vulkan instance.
+- [Chapter 03](chapter-03/chapter-03.md): We continue with the definition of more basic Vulkan concepts such as the physical and Logical devices, surfaces and queues.
+- [Chapter 04](chapter-04/chapter-04.md): The key mechanism to present images to the screen is presented: the Swap chain.
+- [Chapter 05](chapter-05/chapter-05.md): In this chapter we will setup the basic structures for rendering (render information, command buffers and the synchronization mechanisms). 
+- [Chapter 06](chapter-06/chapter-06.md): In this chapter we define the classes required to define the vertices, use the graphics pipeline and create shaders. We will draw our first shape to the screen (a triangle).
+- [Chapter 07](chapter-07/chapter-07.md): In this chapter we go 3D by implementing depth testing and add windows resizing support.
+- [Chapter 08](chapter-08/chapter-08.md): In this chapter we add support for loading complex 3D models using Assimp and textures.
+- [Chapter 09](chapter-09/chapter-09.md): We will automatically generate mipmaps, add support for transparent objects, add a camera to move around the scene and use dynamic uniform objects.
+- [Chapter 10](chapter-10/chapter-10.md): Vulkan Memory Allocator.
+- [Chapter 11](chapter-11/chapter-11.md): Post processing.
+- [Chapter 12](chapter-12/chapter-12.md): Render of GUI elements through ImGui.
+- [Chapter 13](chapter-13/chapter-13.md): Sound with OpenAL. 
+- [Chapter 14](chapter-14/chapter-14.md): Deferred rendering (I).
+- [Chapter 15](chapter-15/chapter-15.md): Deferred rendering (II). 
+- [Chapter 16](chapter-16/chapter-16.md): Cascade shadows.
+- [Chapter 17](chapter-17/chapter-17.md): Animations.

bookcontents/chapter-08/rc08-screen-shot.png

@@ -52,7 +52,7 @@
   ],
   "vtx_path": "resources/models/bob/boblamp.vtx",
   "idx_path": "resources/models/bob/boblamp.idx",
-  "anim_mesh_data_list": [
+  "anim_meshes": [
     {
       "weights": [
         1.0,
@@ -6810,7 +6810,7 @@
       ]
     }
   ],
-  "animations_list": [
+  "animations": [
     {
       "name": "",
       "frame_millis": 5.7916665,

bookcontents/chapter-12/rc12-screen-shot.png

@@ -11,7 +11,6 @@ layout (constant_id = 3) const int DEBUG_SHADOWS = 0;
 const float PI = 3.14159265359;
 const float SHADOW_FACTOR = 0.25;
 
-// color cannot be vec3 due to std140 in GLSL
 struct Light {
     vec4 position;
     vec3 color;
@@ -151,7 +150,7 @@ void main() {
     vec3 pbr       = texture(pbrSampler, inTextCoord).rgb;
 
     float roughness = pbr.g;
-    float metallic = pbr.b;
+    float metallic  = pbr.b;
 
     vec3 N = normalize(normal);
     vec3 V = normalize(sceneInfo.camPos - worldPos);

bookcontents/chapter-14/rc14-screen-shot.png

@@ -21,7 +21,7 @@ void main()
 {
     for (int i = 0; i < 3; i++)
     {
-        outTextCoords  = inTextCoords[i];
+        outTextCoords = inTextCoords[i];
         outMaterialIdx = inMaterialIdx[i];
         gl_Layer = gl_InvocationID;
         gl_Position = projUniforms.projViewMatrices[gl_InvocationID] * gl_in[i].gl_Position;

bookcontents/chapter-15/rc15-screen-shot.png

@@ -20,4 +20,4 @@ void main()
     outMaterialIdx = push_constants.materialIdx;
 
     gl_Position = push_constants.modelMatrix * vec4(entityPos, 1.0f);
- }
+}

bookcontents/chapter-16/rc16-screen-shot-debug.png

@@ -47,7 +47,7 @@ public InitData init(EngCtx engCtx) {
 
         ModelData bobModelData = ModelLoader.loadModel("resources/models/bob/boblamp.json");
         models.add(bobModelData);
-        maxFrames = bobModelData.animationsList().get(0).frames().size();
+        maxFrames = bobModelData.animations().get(0).frames().size();
         bobEntity = new Entity("BobEntity", bobModelData.id(), new Vector3f(0.0f, 0.0f, 0.0f));
         bobEntity.setScale(0.04f);
         bobEntity.getRotation().rotateY((float) Math.toRadians(-90.0f));
@@ -59,9 +59,6 @@ public InitData init(EngCtx engCtx) {
         materials.addAll(ModelLoader.loadMaterials("resources/models/sponza/Sponza_mat.json"));
         materials.addAll(ModelLoader.loadMaterials("resources/models/bob/boblamp_mat.json"));
 
-        List<Entity> animatedEntities = new ArrayList<>();
-        animatedEntities.add(bobEntity);
-
         scene.getAmbientLight().set(0.8f, 0.8f, 0.8f);
         List<Light> lights = new ArrayList<>();
         dirLight = new Light(new Vector4f(0.0f, -1.0f, 0.0f, 0.0f), new Vector4f(5.0f, 5.0f, 5.0f, 1.0f));

bookcontents/chapter-16/rc16-screen-shot.png

@@ -17,8 +17,6 @@ public class EngCfg {
     private boolean fxaa;
     private int maxDescs;
     private int maxJointsMatricesLists;
-    private int maxMaterials;
-    private int maxStorageBuffers;
     private String physDeviceName;
     private int requestedImages;
     private boolean shaderRecompilation;
@@ -50,13 +48,11 @@ private EngCfg() {
             zFar = Float.parseFloat(props.getOrDefault("zFar", 100.f).toString());
             maxDescs = Integer.parseInt(props.getOrDefault("maxDescs", 1000).toString());
             defaultTexturePath = props.getProperty("defaultTexturePath");
-            maxMaterials = Integer.parseInt(props.getOrDefault("maxMaterials", 500).toString());
             fxaa = Boolean.parseBoolean(props.getOrDefault("fxaa", true).toString());
             shadowPcf = Boolean.parseBoolean(props.getOrDefault("shadowPcf", false).toString());
             shadowBias = Float.parseFloat(props.getOrDefault("shadowBias", 0.00005f).toString());
             shadowMapSize = Integer.parseInt(props.getOrDefault("shadowMapSize", 2048).toString());
             shadowDebug = Boolean.parseBoolean(props.getOrDefault("shadowDebug", false).toString());
-            maxStorageBuffers = Integer.parseInt(props.getOrDefault("maxStorageBuffers", 100).toString());
             maxJointsMatricesLists = Integer.parseInt(props.getOrDefault("maxJointsMatricesLists", 100).toString());
         } catch (IOException excp) {
             Logger.error("Could not read [{}] properties file", FILENAME, excp);
@@ -86,14 +82,6 @@ public int getMaxJointsMatricesLists() {
         return maxJointsMatricesLists;
     }
 
-    public int getMaxMaterials() {
-        return maxMaterials;
-    }
-
-    public int getMaxStorageBuffers() {
-        return maxStorageBuffers;
-    }
-
     public String getPhysDeviceName() {
         return physDeviceName;
     }
@@ -149,12 +137,4 @@ public boolean isShadowPcf() {
     public boolean isVkValidate() {
         return vkValidate;
     }
-
-    public void setMaxJointsMatricesLists(int maxJointsMatricesLists) {
-        this.maxJointsMatricesLists = maxJointsMatricesLists;
-    }
-
-    public void setMaxStorageBuffers(int maxStorageBuffers) {
-        this.maxStorageBuffers = maxStorageBuffers;
-    }
 }

bookcontents/chapter-17/chapter-17.md

@@ -2,8 +2,8 @@
 
 import org.joml.Matrix4f;
 import org.lwjgl.system.MemoryUtil;
-import org.vulkanb.eng.graph.vk.Queue;
 import org.vulkanb.eng.graph.vk.*;
+import org.vulkanb.eng.graph.vk.Queue;
 import org.vulkanb.eng.model.*;
 
 import java.io.*;
@@ -29,7 +29,7 @@ private static TransferBuffer createIndicesBuffers(VkCtx vkCtx, MeshData meshDat
                 VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT, VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT);
         var dstBuffer = new VkBuffer(vkCtx, bufferSize,
                 VK_BUFFER_USAGE_TRANSFER_DST_BIT | VK_BUFFER_USAGE_INDEX_BUFFER_BIT, VMA_MEMORY_USAGE_AUTO,
-                VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT, 0);
+                0, 0);
 
         long mappedMemory = srcBuffer.map(vkCtx);
         IntBuffer data = MemoryUtil.memIntBuffer(mappedMemory, (int) srcBuffer.getRequestedSize());
@@ -55,7 +55,7 @@ private static TransferBuffer createJointMatricesBuffers(VkCtx vkCtx, AnimatedFr
                 VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT);
         var dstBuffer = new VkBuffer(vkCtx, bufferSize,
                 VK_BUFFER_USAGE_TRANSFER_DST_BIT | VK_BUFFER_USAGE_STORAGE_BUFFER_BIT, VMA_MEMORY_USAGE_AUTO,
-                VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT, 0);
+                0, 0);
 
         long mappedMemory = srcBuffer.map(vkCtx);
         ByteBuffer matrixBuffer = MemoryUtil.memByteBuffer(mappedMemory, (int) srcBuffer.getRequestedSize());
@@ -75,7 +75,7 @@ private static TransferBuffer createVerticesBuffers(VkCtx vkCtx, MeshData meshDa
                 VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT);
         var dstBuffer = new VkBuffer(vkCtx, bufferSize,
                 VK_BUFFER_USAGE_TRANSFER_DST_BIT | VK_BUFFER_USAGE_VERTEX_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_BUFFER_BIT, VMA_MEMORY_USAGE_AUTO,
-                VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT, 0);
+                0, 0);
 
         long mappedMemory = srcBuffer.map(vkCtx);
         FloatBuffer data = MemoryUtil.memFloatBuffer(mappedMemory, (int) srcBuffer.getRequestedSize());
@@ -101,7 +101,7 @@ private static TransferBuffer createWeightsBuffers(VkCtx vkCtx, AnimMeshData ani
                 VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT);
         var dstBuffer = new VkBuffer(vkCtx, bufferSize,
                 VK_BUFFER_USAGE_TRANSFER_DST_BIT | VK_BUFFER_USAGE_VERTEX_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_BUFFER_BIT,
-                VMA_MEMORY_USAGE_AUTO, VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT, 0);
+                VMA_MEMORY_USAGE_AUTO, 0, 0);
 
         long mappedMemory = srcBuffer.map(vkCtx);
         FloatBuffer data = MemoryUtil.memFloatBuffer(mappedMemory, (int) srcBuffer.getRequestedSize());
@@ -148,7 +148,7 @@ public void loadModels(VkCtx vkCtx, List<ModelData> models, CmdPool cmdPool, Que
                 VulkanModel vulkanModel = new VulkanModel(modelData.id());
                 modelsMap.put(vulkanModel.getId(), vulkanModel);
 
-                List<Animation> animationsList = modelData.animationsList();
+                List<Animation> animationsList = modelData.animations();
                 boolean hasAnimation = animationsList != null && !animationsList.isEmpty();
                 if (hasAnimation) {
                     for (Animation animation : animationsList) {
@@ -178,7 +178,7 @@ public void loadModels(VkCtx vkCtx, List<ModelData> models, CmdPool cmdPool, Que
                     indicesBuffers.recordTransferCommand(cmd);
 
                     TransferBuffer weightsBuffers = null;
-                    List<AnimMeshData> animMeshDataList = modelData.animMeshDataList();
+                    List<AnimMeshData> animMeshDataList = modelData.animMeshes();
                     if (animMeshDataList != null && !animMeshDataList.isEmpty()) {
                         weightsBuffers = createWeightsBuffers(vkCtx, animMeshDataList.get(meshCount));
                         stagingBufferList.add(weightsBuffers.srcBuffer());

bookcontents/chapter-17/rc17-screen-shot.png

@@ -2,6 +2,6 @@
 
 import java.util.List;
 
-public record ModelData(String id, List<MeshData> meshes, String vtxPath, String idxPath,
-                        List<AnimMeshData> animMeshDataList, List<Animation> animationsList) {
+public record ModelData(String id, List<MeshData> meshes, String vtxPath, String idxPath, List<AnimMeshData> animMeshes,
+                        List<Animation> animations) {
 }

booksamples/chapter-17/resources/models/bob/boblamp.json

@@ -318,7 +318,7 @@ private void mainProcessing() throws IOException {
             throw new RuntimeException("Model path does not exist [" + modelPath + "]");
         }
 
-        AIScene aiScene = aiImportFile(modelPath, FLAGS | (animation ? 0 : aiProcess_PreTransformVertices));
+        AIScene aiScene = aiImportFile(modelPath, FLAGS | (animation ? aiProcess_LimitBoneWeights : aiProcess_PreTransformVertices));
         if (aiScene == null) {
             throw new RuntimeException("Error loading model [modelPath: " + modelPath + "]");
         }
@@ -386,6 +386,7 @@ private void mainProcessing() throws IOException {
         Logger.info("Generated materials file [{}]", outMaterialFile);
 
         modelBinData.close();
+        aiReleaseImport(aiScene);
         Logger.info("Generated vtx file [{}]", modelBinData.getVtxFilePath());
         Logger.info("Generated idx file [{}]", modelBinData.getIdxFilePath());
     }

booksamples/chapter-17/resources/shaders/anim_comp.glsl.spv

@@ -43,7 +43,7 @@ public List<Entity> getEntities() {
     }
 
     public Light[] getLights() {
-        return this.lights;
+        return lights;
     }
 
     public Projection getProjection() {

booksamples/chapter-17/resources/shaders/gui_frg.glsl.spv

@@ -1,4 +1,4 @@
-debugShaders=true
+debugShaders=false
 defaultTexturePath=resources/models/default/default.png
 fov=60
 fxaa=true