Mouse picking is working from rendering side

- Buffer now has function to get data from mapped pointer if it exists
- Batches now also pass a buffer of EIDs to the GPU
- Global vertex attributes now have 1 extra instanced attribute for storing EntityIDs
- Render graph resources now have a usage flags on top of the usage flags calculated in the graph AddResource function. This is to tell vulkan that we want some resources to be copyable for example (EID render target copy to buffer).
-  Mouse pick system stores eid picked

SHADE_Engine/src/Graphics/Buffers/SHVkBuffer.h

@@ -105,6 +105,17 @@ namespace SHADE
     vk::Buffer GetVkBuffer (void) const noexcept;
     vk::BufferUsageFlags GetUsageBits(void) const noexcept;
 
+    template <typename T>
+    T GetDataFromMappedPointer(uint32_t index) const noexcept
+    {
+      if (mappedPtr && index < sizeStored / sizeof (T))
+      {
+        return (static_cast<T*>(mappedPtr))[index];
+      }
+      else
+        return {};
+    };
+
   };
 }
 

SHADE_Engine/src/Graphics/MiddleEnd/Batching/SHBatch.cpp

@@ -110,6 +110,7 @@ namespace SHADE
         // Clear CPU buffers
         drawData.clear();
         transformData.clear();
+        eidData.clear();
         matPropsData.reset();
         matPropsDataSize = 0;
 
@@ -119,6 +120,7 @@ namespace SHADE
         {
             drawDataBuffer[i].Free();
             transformDataBuffer[i].Free();
+            eidBuffer[i].Free();
             matPropsBuffer[i].Free();
         }
     }
@@ -206,7 +208,31 @@ namespace SHADE
           transformDataBuffer[frameIndex]->WriteToMemory(transformData.data(), static_cast<uint32_t>(transformData.size() * sizeof(SHMatrix)), 0, 0);
     }
 
-    void SHBatch::Build(Handle<SHVkLogicalDevice> _device, Handle<SHVkDescriptorPool> descPool, uint32_t frameIndex)
+  void SHBatch::UpdateEIDBuffer(uint32_t frameIndex)
+  {
+    if (frameIndex >= SHGraphicsConstants::NUM_FRAME_BUFFERS)
+    {
+      SHLOG_WARNING("[SHBatch] Attempted to update eid buffers with an invalid frame index.");
+      return;
+    }
+
+    // Reset Transform Data
+    eidData.clear();
+
+    // Populate on the CPU
+    for (auto& subBatch : subBatches)
+      for (const SHRenderable* renderable : subBatch.Renderables)
+      {
+        eidData.emplace_back(renderable->GetEID());
+      }
+
+    // Transfer to GPU
+    if (eidBuffer[frameIndex])
+      eidBuffer[frameIndex]->WriteToMemory(eidData.data(), static_cast<EntityID>(eidData.size() * sizeof(EntityID)), 0, 0);
+
+  }
+
+  void SHBatch::Build(Handle<SHVkLogicalDevice> _device, Handle<SHVkDescriptorPool> descPool, uint32_t frameIndex)
     {
         if (frameIndex >= SHGraphicsConstants::NUM_FRAME_BUFFERS)
         {
@@ -237,6 +263,11 @@ namespace SHADE
             // - Transform data
             transformData.reserve(numTotalElements);
             transformData.clear();
+            // - EID data
+            eidData.reserve(numTotalElements);
+            eidData.clear();
+
+
             // - Material Properties Data
 		    const Handle<SHShaderBlockInterface> SHADER_INFO = pipeline->GetPipelineLayout()->GetShaderBlockInterface
 		    (
@@ -277,7 +308,8 @@ namespace SHADE
                 for (const SHRenderable* renderable : subBatch.Renderables)
                 {
                     // Transform
-                    auto transform = SHComponentManager::GetComponent_s<SHTransformComponent>(renderable->GetEID());
+                    EntityID eid = renderable->GetEID();
+                    auto transform = SHComponentManager::GetComponent_s<SHTransformComponent>(eid);
                     if (!transform)
                     {
                         SHLOG_WARNING("[SHBatch] Entity contianing a SHRenderable with no SHTransformComponent found!");
@@ -287,6 +319,8 @@ namespace SHADE
                     {
                         transformData.emplace_back(transform->GetTRS());
                     }
+
+                    eidData.emplace_back(eid);
                    
                     // Material Properties
                     if (!EMPTY_MAT_PROPS)
@@ -317,6 +351,12 @@ namespace SHADE
             device, transformDataBuffer[frameIndex], transformData.data(), TF_DATA_BYTES,
             BuffUsage::eVertexBuffer
         );
+        const uint32_t EID_DATA_BYTES = static_cast<uint32_t>(eidData.size() * sizeof(EntityID));
+        SHVkUtil::EnsureBufferAndCopyHostVisibleData
+        (
+          device, eidBuffer[frameIndex], eidData.data(), EID_DATA_BYTES,
+          BuffUsage::eVertexBuffer
+        );
         // - Material Properties Buffer
         rebuildMaterialBuffers(frameIndex, descPool);
 
@@ -339,6 +379,7 @@ namespace SHADE
         static std::array<uint32_t, 1> dynamicOffset { 0 };
         cmdBuffer->BindPipeline(pipeline);
         cmdBuffer->BindVertexBuffer(SHGraphicsConstants::VertexBufferBindings::TRANSFORM, transformDataBuffer[frameIndex], 0);
+        cmdBuffer->BindVertexBuffer(SHGraphicsConstants::VertexBufferBindings::EID,       eidBuffer[frameIndex], 0);
         if (matPropsDescSet[frameIndex])
         {
           cmdBuffer->BindDescriptorSet

SHADE_Engine/src/Graphics/MiddleEnd/Batching/SHBatch.h

@@ -22,6 +22,7 @@ of DigiPen Institute of Technology is prohibited.
 #include "Graphics/MiddleEnd/Interface/SHMaterial.h"
 #include "Math/SHMatrix.h"
 #include "Graphics/MiddleEnd/Interface/SHGraphicsConstants.h"
+#include "ECS_Base/SHECSMacros.h"
 
 namespace SHADE
 {
@@ -78,6 +79,7 @@ namespace SHADE
         void Clear();
         void UpdateMaterialBuffer(uint32_t frameIndex, Handle<SHVkDescriptorPool> descPool);
         void UpdateTransformBuffer(uint32_t frameIndex);
+        void UpdateEIDBuffer(uint32_t frameIndex);
         void Build(Handle<SHVkLogicalDevice> device, Handle<SHVkDescriptorPool> descPool, uint32_t frameIndex)  ;
         void Draw(Handle<SHVkCommandBuffer> cmdBuffer, uint32_t frameIndex);
 
@@ -109,14 +111,16 @@ namespace SHADE
         // CPU Buffers                                 
         std::vector<vk::DrawIndexedIndirectCommand>    drawData;
         std::vector<SHMatrix>                          transformData;
+        std::vector<EntityID>                          eidData;
         std::unique_ptr<char>                          matPropsData;
         Byte                                           matPropsDataSize          = 0;
         Byte                                           singleMatPropAlignedSize  = 0;
-		Byte                                           singleMatPropSize         = 0;
+		Byte                                           singleMatPropSize             = 0;
         bool isCPUBuffersDirty                                                   = true;
         // GPU Buffers                                 
         TripleBuffer                                   drawDataBuffer;
         TripleBuffer                                   transformDataBuffer;
+        TripleBuffer                                   eidBuffer;
         TripleBuffer                                   matPropsBuffer;
         TripleDescSet                                  matPropsDescSet;
 

SHADE_Engine/src/Graphics/MiddleEnd/Batching/SHSuperBatch.cpp

@@ -83,8 +83,9 @@ namespace SHADE
     {
         for (auto& batch : batches)
         {
-			batch.UpdateMaterialBuffer(frameIndex, descPool);
+			      batch.UpdateMaterialBuffer(frameIndex, descPool);
             batch.UpdateTransformBuffer(frameIndex);
+            batch.UpdateEIDBuffer(frameIndex);
         }
     }
 

SHADE_Engine/src/Graphics/MiddleEnd/GlobalData/SHGraphicsGlobalData.cpp

@@ -91,9 +91,10 @@ namespace SHADE
   {
     defaultVertexInputState.AddBinding(false, false, { SHVertexAttribute(SHAttribFormat::FLOAT_3D) }); // positions at binding 0
     defaultVertexInputState.AddBinding(false, false, { SHVertexAttribute(SHAttribFormat::FLOAT_2D) }); // UVs at binding 1
-    defaultVertexInputState.AddBinding(false, false, {SHVertexAttribute(SHAttribFormat::FLOAT_3D)}); // Normals at binding 2
+    defaultVertexInputState.AddBinding(false, false, { SHVertexAttribute(SHAttribFormat::FLOAT_3D) }); // Normals at binding 2
-    defaultVertexInputState.AddBinding(false, false, {SHVertexAttribute(SHAttribFormat::FLOAT_3D)}); // Tangents at binding 3
+    defaultVertexInputState.AddBinding(false, false, { SHVertexAttribute(SHAttribFormat::FLOAT_3D) }); // Tangents at binding 3
-    defaultVertexInputState.AddBinding(true, true,   {SHVertexAttribute(SHAttribFormat::MAT_4D)}); // Transform at binding 4 - 7 (4 slots)
+    defaultVertexInputState.AddBinding(true, true,   { SHVertexAttribute(SHAttribFormat::MAT_4D)   }); // Transform at binding 4 - 7 (4 slots)
+    defaultVertexInputState.AddBinding(true, true,   { SHVertexAttribute(SHAttribFormat::UINT32_1D) }); // EID at binding 8
   }
 
   void SHGraphicsGlobalData::Init(Handle<SHVkLogicalDevice> logicalDevice) noexcept

SHADE_Engine/src/Graphics/MiddleEnd/Interface/SHGraphicsConstants.h

@@ -144,6 +144,14 @@ namespace SHADE
       */
       /***************************************************************************/
       static constexpr uint32_t TRANSFORM = 4;
+      /***************************************************************************/
+      /*!
+        \brief
+          Vertex buffer bindings for the eid buffer.
+      */
+      /***************************************************************************/
+      static constexpr uint32_t EID = 5;
+
     };
 
     /*******************************************************************************/

SHADE_Engine/src/Graphics/MiddleEnd/Interface/SHGraphicsSystem.cpp

@@ -146,7 +146,7 @@ namespace SHADE
     worldRenderGraph->Init(device, swapchain);
     worldRenderGraph->AddResource("Present", SH_ATT_DESC_TYPE::COLOR_PRESENT, windowDims.first, windowDims.second);
     worldRenderGraph->AddResource("Depth Buffer", SH_ATT_DESC_TYPE::DEPTH_STENCIL, windowDims.first, windowDims.second, vk::Format::eD32SfloatS8Uint);
-    worldRenderGraph->AddResource("Entity ID", SH_ATT_DESC_TYPE::COLOR, windowDims.first, windowDims.second, vk::Format::eR32Uint);
+    worldRenderGraph->AddResource("Entity ID", SH_ATT_DESC_TYPE::COLOR, windowDims.first, windowDims.second, vk::Format::eR32Uint, 1, vk::ImageUsageFlagBits::eTransferSrc);
 
     //worldRenderGraph->AddResource("Position", SH_ATT_DESC_TYPE::COLOR, windowDims.first, windowDims.second, vk::Format::eR16G16B16A16Sfloat);
     //worldRenderGraph->AddResource("Normals", SH_ATT_DESC_TYPE::COLOR, windowDims.first, windowDims.second, vk::Format::eR16G16B16A16Sfloat);

SHADE_Engine/src/Graphics/MiddleEnd/Interface/SHGraphicsSystem.h

@@ -269,6 +269,7 @@ namespace SHADE
     Handle<SHVkQueue> GetQueue() const { return graphicsQueue; }
     Handle<SHVkDescriptorPool> GetDescriptorPool() const { return descPool; }
     Handle<SHViewport> GetDefaultViewport() const {return defaultViewport;}
+    Handle<SHMousePickSystem> GetMousePickSystem(void) const noexcept {return mousePickSystem;};
     //SHRenderGraph const& GetRenderGraph(void) const noexcept;
 
     //Handle<SHVkRenderpass> GetRenderPass() const { return renderPass; }

SHADE_Engine/src/Graphics/MiddleEnd/Interface/SHMousePickSystem.cpp

@@ -11,6 +11,8 @@ namespace SHADE
 {
   void SHMousePickSystem::Init(Handle<SHVkLogicalDevice> logicalDevice, std::span<Handle<SHVkCommandPool>> cmdPools, Handle<SHRenderGraphResource> eidAttachment) noexcept
   {
+    pickedEID = 0;
+
     // Create command buffers
     for (auto& pool : cmdPools)
     {
@@ -32,28 +34,38 @@ namespace SHADE
   void SHMousePickSystem::Run(Handle<SHVkQueue> queue, uint32_t frameIndex) noexcept
   {
     // if input detected
-    if (/*SHInputManager::GetKey(SHInputManager::SH_KEYCODE::LEFT_CTRL) && */SHInputManager::GetKeyUp(SHInputManager::SH_KEYCODE::LMB))
+    if (SHInputManager::GetKey(SHInputManager::SH_KEYCODE::LEFT_CTRL) && SHInputManager::GetKeyUp(SHInputManager::SH_KEYCODE::LMB))
     {
-      std::cout << "Input registered... " << std::endl;
+      afterCopyFence->Reset();
 
-      //// begin command buffer for recording
+      // begin command buffer for recording
-      //commandBuffers[frameIndex]->BeginRecording();
+      commandBuffers[frameIndex]->BeginRecording();
 
-      //// transition the image for optimized copying
+      // transition the image for optimized copying
-      //entityIDAttachment->TransitionImage (vk::ImageLayout::eColorAttachmentOptimal, vk::ImageLayout::eTransferSrcOptimal, commandBuffers[frameIndex], vk::PipelineStageFlagBits::eColorAttachmentOutput, vk::PipelineStageFlagBits::eTransfer, 0);
+      entityIDAttachment->TransitionImage (vk::ImageLayout::eColorAttachmentOptimal, vk::ImageLayout::eTransferSrcOptimal, commandBuffers[frameIndex], vk::PipelineStageFlagBits::eColorAttachmentOutput, vk::PipelineStageFlagBits::eTransfer, 0);
 
-      //// copy the image here. Last argument is 0 because the attachment isn't a swapchain image.
+      // copy the image here. Last argument is 0 because the attachment isn't a swapchain image.
-      //entityIDAttachment->CopyToBuffer(imageDataDstBuffer, commandBuffers[frameIndex], 0);
+      entityIDAttachment->CopyToBuffer(imageDataDstBuffer, commandBuffers[frameIndex], 0);
 
-      //// end command buffer for recording
+      // end command buffer for recording
-      //commandBuffers[frameIndex]->EndRecording();
+      commandBuffers[frameIndex]->EndRecording();
 
-      //// submit the command buffer to copy image to buffer
+      // submit the command buffer to copy image to buffer
-      //queue->SubmitCommandBuffer({ commandBuffers[frameIndex] }, {}, {}, vk::PipelineStageFlagBits::eColorAttachmentOutput, afterCopyFence);
+      queue->SubmitCommandBuffer({ commandBuffers[frameIndex] }, {}, {}, vk::PipelineStageFlagBits::eColorAttachmentOutput, afterCopyFence);
 
-      //// wait for the copy to be done
+      // wait for the copy to be done
-      //afterCopyFence->Wait(true, std::numeric_limits<uint64_t>::max());
+      afterCopyFence->Wait(true, std::numeric_limits<uint64_t>::max());
+
+      int mouseX = 0, mouseY = 0;
+      SHInputManager::GetMouseWindowPosition(&mouseX, &mouseY);
+
+      pickedEID = imageDataDstBuffer->GetDataFromMappedPointer<uint32_t>(mouseY * entityIDAttachment->GetWidth() + mouseX);
     }
   }
 
+  EntityID SHMousePickSystem::GetPickedEntity(void) const noexcept
+  {
+    return pickedEID;
+  }
+
 }

SHADE_Engine/src/Graphics/MiddleEnd/Interface/SHMousePickSystem.h

@@ -29,10 +29,19 @@ namespace SHADE
     //! buffer to contain the attachment data after copying
     Handle<SHVkBuffer> imageDataDstBuffer;
 
+    //! eid picked from screen
+    EntityID pickedEID;
   public:
+    /*-----------------------------------------------------------------------*/
+    /* PUBLIC MEMBER FUNCTIONS                                              */
+    /*-----------------------------------------------------------------------*/
     void Init(Handle<SHVkLogicalDevice> logicalDevice, std::span<Handle<SHVkCommandPool>> cmdPools, Handle<SHRenderGraphResource> eidAttachment) noexcept;
-
     void Run (Handle<SHVkQueue> queue, uint32_t frameIndex) noexcept; 
 
+    /*-----------------------------------------------------------------------*/
+    /* SETTERS AND GETTERS                                                   */
+    /*-----------------------------------------------------------------------*/
+    EntityID GetPickedEntity (void) const noexcept;
+
   };
 }

SHADE_Engine/src/Graphics/RenderGraph/SHRenderGraph.cpp

@@ -40,7 +40,7 @@ namespace SHADE
 
   */
   /***************************************************************************/
-  void SHRenderGraph::AddResource(std::string resourceName, SH_ATT_DESC_TYPE type, uint32_t w /*= static_cast<uint32_t>(-1)*/, uint32_t h /*= static_cast<uint32_t>(-1)*/, vk::Format format/* = vk::Format::eB8G8R8A8Unorm*/, uint8_t levels /*= 1*/, vk::ImageCreateFlagBits createFlags /*= {}*/)
+  void SHRenderGraph::AddResource(std::string resourceName, SH_ATT_DESC_TYPE type, uint32_t w /*= static_cast<uint32_t>(-1)*/, uint32_t h /*= static_cast<uint32_t>(-1)*/, vk::Format format/* = vk::Format::eB8G8R8A8Unorm*/, uint8_t levels /*= 1*/, vk::ImageUsageFlagBits usageFlags/* = {}*/, vk::ImageCreateFlagBits createFlags /*= {}*/)
   {
     // If we set to 
     if (w == static_cast<uint32_t>(-1) && h == static_cast<uint32_t>(-1))
@@ -50,7 +50,7 @@ namespace SHADE
       format = swapchainHdl->GetSurfaceFormatKHR().format;
     }
 
-    graphResources.try_emplace(resourceName, resourceManager.Create<SHRenderGraphResource>(logicalDeviceHdl, swapchainHdl, resourceName, type, format, w, h, levels, createFlags));
+    graphResources.try_emplace(resourceName, resourceManager.Create<SHRenderGraphResource>(logicalDeviceHdl, swapchainHdl, resourceName, type, format, w, h, levels, usageFlags, createFlags));
   }
 
   /***************************************************************************/

SHADE_Engine/src/Graphics/RenderGraph/SHRenderGraph.h

@@ -75,7 +75,7 @@ namespace SHADE
     /* PUBLIC MEMBER FUNCTIONS                                               */
     /*-----------------------------------------------------------------------*/
     void Init (Handle<SHVkLogicalDevice> const& logicalDevice, Handle<SHVkSwapchain> const& swapchain) noexcept;
-    void                      AddResource  (std::string resourceName, SH_ATT_DESC_TYPE type, uint32_t w = static_cast<uint32_t>(-1), uint32_t h = static_cast<uint32_t>(-1), vk::Format format = vk::Format::eB8G8R8A8Unorm, uint8_t levels = 1, vk::ImageCreateFlagBits createFlags = {});
+    void                      AddResource(std::string resourceName, SH_ATT_DESC_TYPE type, uint32_t w = static_cast<uint32_t>(-1), uint32_t h = static_cast<uint32_t>(-1), vk::Format format = vk::Format::eB8G8R8A8Unorm, uint8_t levels = 1, vk::ImageUsageFlagBits usageFlags = {}, vk::ImageCreateFlagBits createFlags = {});
     Handle<SHRenderGraphNode> AddNode      (std::string nodeName, std::initializer_list<std::string> resourceNames, std::initializer_list<std::string> predecessorNodes) noexcept;
     void                      Generate     (void) noexcept;
     void Execute (uint32_t frameIndex, Handle<SHVkCommandBuffer> cmdBuffer, Handle<SHVkDescriptorPool> descPool) noexcept;

SHADE_Engine/src/Graphics/RenderGraph/SHRenderGraphResource.cpp

@@ -45,7 +45,7 @@ namespace SHADE
 
   */
   /***************************************************************************/
-  SHRenderGraphResource::SHRenderGraphResource(Handle<SHVkLogicalDevice> const& logicalDevice, Handle<SHVkSwapchain> const& swapchain, std::string const& name, SH_ATT_DESC_TYPE type, vk::Format format, uint32_t w, uint32_t h, uint8_t levels, vk::ImageCreateFlagBits createFlags) noexcept
+  SHRenderGraphResource::SHRenderGraphResource(Handle<SHVkLogicalDevice> const& logicalDevice, Handle<SHVkSwapchain> const& swapchain, std::string const& name, SH_ATT_DESC_TYPE type, vk::Format format, uint32_t w, uint32_t h, uint8_t levels, vk::ImageUsageFlagBits usageFlags, vk::ImageCreateFlagBits createFlags) noexcept
     : logicalDevice {logicalDevice}
     , swapchain{ swapchain }
     , resourceType{ type }
@@ -61,7 +61,7 @@ namespace SHADE
     if (resourceType != SH_ATT_DESC_TYPE::COLOR_PRESENT)
     {
       imageAspectFlags = vk::ImageAspectFlags{};
-      usage = {};
+      usage = usageFlags;
 
       // Check the resource type and set image usage flags and image aspect flags accordingly
       switch (resourceType)

SHADE_Engine/src/Graphics/RenderGraph/SHRenderGraphResource.h

@@ -67,7 +67,7 @@ namespace SHADE
     /*-----------------------------------------------------------------------*/
     /* CTORS AND DTORS                                                       */
     /*-----------------------------------------------------------------------*/
-    SHRenderGraphResource(Handle<SHVkLogicalDevice> const& logicalDevice, Handle<SHVkSwapchain> const& swapchain, std::string const& name, SH_ATT_DESC_TYPE type, vk::Format format, uint32_t w, uint32_t h, uint8_t levels, vk::ImageCreateFlagBits createFlags) noexcept;
+    SHRenderGraphResource(Handle<SHVkLogicalDevice> const& logicalDevice, Handle<SHVkSwapchain> const& swapchain, std::string const& name, SH_ATT_DESC_TYPE type, vk::Format format, uint32_t w, uint32_t h, uint8_t levels, vk::ImageUsageFlagBits usageFlags, vk::ImageCreateFlagBits createFlags) noexcept;
     SHRenderGraphResource(SHRenderGraphResource&& rhs) noexcept;
     SHRenderGraphResource& operator=(SHRenderGraphResource&& rhs) noexcept;
     ~SHRenderGraphResource(void) noexcept;

TempShaderFolder/TestCubeFs.glsl

@@ -22,6 +22,7 @@ layout(location = 0) in struct
 layout(location = 2) flat in struct
 {
   int materialIndex;
+  uint eid;
 } In2;
 
 //layout (set = 0, binding = )
@@ -40,6 +41,6 @@ void main()
   outColor = texture(textures[nonuniformEXT(MatProp.data[In2.materialIndex].textureIndex)], In.uv) +
     MatProp.data[In2.materialIndex].color / MatProp.data[In2.materialIndex].alpha;
 
-  outEntityID = 5;
+  outEntityID = In2.eid;
   //outColor = vec4 (1.0f);
 }

TempShaderFolder/TestCubeVs.glsl

@@ -8,6 +8,7 @@ layout(location = 1) in vec2 aUV;
 layout(location = 2) in vec3 aNormal;
 layout(location = 3) in vec3 aTangent;
 layout(location = 4) in mat4 worldTransform;
+layout(location = 8) in uint eid;
 
 
 layout(location = 0) out struct
@@ -21,6 +22,8 @@ layout(location = 0) out struct
 layout(location = 2) out struct
 {
   int materialIndex;
+  uint eid;
+
 } Out2;
 
 layout(set = 2, binding = 0) uniform CameraData
@@ -33,6 +36,7 @@ void main()
 {
   Out.uv = aUV;
   Out2.materialIndex = gl_InstanceIndex;
+  Out2.eid = eid;
   gl_Position = cameraData.vpMat * worldTransform * vec4 (aVertexPos, 1.0f);
   Out.vertColor = vec4 (aVertexPos, 1.0f);
 }