Merge pull request #634 from novelrt/feature/sprite-rendering-system

Re-introduce sprite rendering to the ECS.

Author: FiniteReality

Ecs/Core/EcsDefaultsBuilder.cpp

@@ -2,14 +2,16 @@
 // for more information.
 
 #include <NovelRT/Ecs/EcsDefaultsBuilder.hpp>
+#include <NovelRT/Maths/GeoVector2F.hpp>
+#include <NovelRT/Maths/GeoVector3F.hpp>
 
 using namespace NovelRT::Ecs;
 
 EcsDefaultsBuilder::EcsDefaultsBuilder()
     : _defaultEntityGraphComponent{false, std::numeric_limits<EntityId>::max(), std::numeric_limits<EntityId>::max()},
       _defaultLinkedEntityListNodeComponent{false, std::numeric_limits<EntityId>::max(),
                                             std::numeric_limits<EntityId>::max()},
-      _defaultTransformComponent{Maths::GeoVector3F::Uniform(NAN), Maths::GeoVector2F::Uniform(NAN), NAN} {};
+      _defaultTransformComponent{Maths::GeoVector2F::Uniform(NAN), Maths::GeoVector2F::Uniform(NAN), NAN} {};
 
 EcsDefaultsBuilder& NovelRT::Ecs::EcsDefaultsBuilder::WithDefaultEntityGraphComponent(
     const Components::EntityGraphComponent& defaultGraphComponent)

Ecs/Core/SystemScheduler.cpp

@@ -262,6 +262,8 @@ namespace NovelRT::Ecs
                             });
                     }
 
+                    _ecsTasks->wait();
+
                     for (SystemId systemId : layer)
                     {
                         _ecsTasks->run(

Ecs/Core/include/NovelRT/Ecs/Catalogue.hpp

@@ -118,7 +118,8 @@ namespace NovelRT::Ecs
          * callback that is executed on the next iteration of the ECS once the work is done.
          *
          * The work functor is executed asynchronously on a separate thread pool and must not interact
-         * with the ECS or capture any references to a Catalogue instance, as the behaviour is undefined.
+         * with ECS memory regions or capture any references to a Catalogue instance, as the behaviour is undefined.
+         * Capturing the this pointer of an IEcsSystem instance is safe and OK to do.
          * The completion functor is executed on the ECS thread pool in the next available iteration,
          * and receives a fresh Catalogue instance with the correct threading context, the current delta time,
          * and the result of the work functor.

Ecs/Core/include/NovelRT/Ecs/ComponentView.hpp

@@ -92,6 +92,22 @@ namespace NovelRT::Ecs
             PushComponentUpdateInstruction(entity, _componentBuffer.GetDeleteInstructionState());
         }
 
+        /**
+         * @brief Removes all components of the given type from the ECS simulation.
+         *
+         * @param entity The EntityId to remove the component from.
+         *
+         * @exception Exceptions::DuplicateKeyException when multiple update instructions are pushed to this buffer on
+         * the same thread.
+         */
+        void RemoveAllComponents()
+        {
+            for (auto&& [entity, component] : *this)
+            {
+                RemoveComponent(entity);
+            }
+        }
+
         /**
          * @brief Gets the immutable component state for a delete instruction.
          *

Ecs/Core/include/NovelRT/Ecs/Components/TransformComponent.hpp

@@ -14,13 +14,13 @@ namespace NovelRT::Ecs::Components
 {
     struct TransformComponent
     {
-        Maths::GeoVector3F positionAndLayer = Maths::GeoVector3F::Zero();
+        Maths::GeoVector2F position = Maths::GeoVector2F::Zero();
         Maths::GeoVector2F scale = Maths::GeoVector2F::One();
         float rotationInRadians = 0.0f;
 
         inline TransformComponent& operator+=(const TransformComponent& other)
         {
-            positionAndLayer += other.positionAndLayer;
+            position += other.position;
             rotationInRadians += other.rotationInRadians;
             scale += other.scale;
 
@@ -38,7 +38,7 @@ namespace NovelRT::Ecs::Components
 
         friend inline bool operator==(const TransformComponent& lhs, const TransformComponent& rhs) noexcept
         {
-            return lhs.positionAndLayer == rhs.positionAndLayer && lhs.scale == rhs.scale &&
+            return lhs.position == rhs.position && lhs.scale == rhs.scale &&
                    lhs.rotationInRadians == rhs.rotationInRadians;
         }
 

Ecs/Core/include/NovelRT/Ecs/MiscTemplateImpls.hpp

@@ -25,13 +25,14 @@ namespace NovelRT::Ecs
             [&]()
             {
                 _asyncTasks->run(
-                    [work = std::forward<TWork>(work), completion = std::forward<TCompletion>(completion),
-                     this]() mutable
+                    [work = std::make_shared<std::decay_t<TWork>>(std::forward<TWork>(work)),
+                     completion = std::make_shared<std::decay_t<TCompletion>>(std::forward<TCompletion>(completion)),
+                     this]()
                     {
-                        auto result = work();
-                        _pendingCompletions.push([completion = std::move(completion), result = std::move(result)](
-                                                     Timing::Timestamp delta, Catalogue cat) mutable
-                                                 { completion(delta, cat, std::move(result)); });
+                        auto result = (*work)();
+                        _pendingCompletions.push(
+                            [completion, result = std::move(result)](Timing::Timestamp delta, Catalogue cat) mutable
+                            { (*completion)(delta, cat, std::move(result)); });
                     });
             });
     }

Ecs/Graphics/CMakeLists.txt

@@ -4,6 +4,7 @@ NovelRTBuildSystem_DeclareModule(LIBRARY NovelRT::Ecs::Graphics
   DEPENDS
     NovelRT::Ecs::Core
     NovelRT::Graphics
+    NovelRT::ResourceManagement::Desktop
 
   SOURCES
     PRIVATE
@@ -17,4 +18,7 @@ NovelRTBuildSystem_DeclareModule(LIBRARY NovelRT::Ecs::Graphics
       include/NovelRT/Ecs/Graphics/EcsGraphicsBuilder.hpp
       include/NovelRT/Ecs/Graphics/RenderOrchestratorSystem.hpp
       include/NovelRT/Ecs/Graphics/SpriteRendererSystem.hpp
+      include/NovelRT/Ecs/Graphics/Components/TrackedSemaphore.hpp
+      include/NovelRT/Ecs/Graphics/Components/Camera.hpp
+      include/NovelRT/Ecs/Graphics/Components/Viewport.hpp
 )

Ecs/Graphics/include/NovelRT/Ecs/Graphics/Components/BuiltCommandList.hpp

@@ -18,7 +18,10 @@ namespace NovelRT::Ecs::Graphics::Components
         inline BuiltCommandList& operator+=(const BuiltCommandList& other)
         {
             if (commandList != nullptr)
+            {
                 delete commandList;
+            }
+
             *this = other;
             return *this;
         }

Ecs/Graphics/include/NovelRT/Ecs/Graphics/Components/Camera.hpp

@@ -0,0 +1,42 @@
+#pragma once
+
+// Copyright © Matt Jones and Contributors. Licensed under the MIT Licence (MIT). See LICENCE.md in the repository root
+// for more information.
+
+namespace NovelRT::Ecs::Graphics::Components
+{
+    struct Camera
+    {
+        float left = -1.0f;
+        float right = 1.0f;
+        float bottom = -1.0f;
+        float top = 1.0f;
+        float nearPlane = 0.0f;
+        float farPlane = 1.0f;
+        int32_t referenceResolutionWidth = 100;
+        int32_t referenceResolutionHeight = 100;
+
+        bool isScreenSpace = false;
+
+        inline Camera& operator+=(const Camera& other)
+        {
+            *this = other;
+            return *this;
+        }
+
+        [[nodiscard]] inline bool operator==(const Camera& other) const noexcept
+        {
+            // normally I would care more about floating point comparison but this is basically only here to handle
+            // deletion, where it'll always be zero. - Matt J.
+            return left == other.left && right == other.right && bottom == other.bottom && top == other.top &&
+                   nearPlane == other.nearPlane && farPlane == other.farPlane && isScreenSpace == other.isScreenSpace &&
+                   referenceResolutionWidth == other.referenceResolutionWidth &&
+                   referenceResolutionHeight == other.referenceResolutionHeight;
+        }
+
+        [[nodiscard]] inline bool operator!=(const Camera& other) const noexcept
+        {
+            return !(*this == other);
+        }
+    };
+}

Ecs/Graphics/include/NovelRT/Ecs/Graphics/Components/RenderPass.hpp

@@ -15,20 +15,24 @@ namespace NovelRT::Ecs::Graphics::Components
     struct RenderPass
     {
         RenderPassId renderPassIndex;
-
-        std::shared_ptr<NovelRT::Graphics::GraphicsDescriptorSet<TGraphicsBackend>>* descriptorSet;
+        std::shared_ptr<NovelRT::Graphics::GraphicsDescriptorSet<TGraphicsBackend>>* descriptorSets;
+        size_t descriptorSetCount = 0;
 
         inline RenderPass& operator+=(const RenderPass& other)
         {
-            if (descriptorSet != nullptr)
-                delete descriptorSet;
+            if (descriptorSets != nullptr)
+            {
+                delete[] descriptorSets;
+            }
+
             *this = other;
             return *this;
         }
 
         [[nodiscard]] inline bool operator==(const RenderPass& other) const noexcept
         {
-            return renderPassIndex == other.renderPassIndex;
+            return renderPassIndex == other.renderPassIndex && descriptorSets == other.descriptorSets &&
+                   descriptorSetCount == other.descriptorSetCount;
         }
 
         [[nodiscard]] inline bool operator!=(const RenderPass& other) const noexcept