Add FColour and IColour to Renderer

Raelr · Raelr · commit b99c01a218b3 · 2023-03-03T14:20:11.000+11:00
diff --git a/engine/render/renderer/lights/PointLight.cpp b/engine/render/renderer/lights/PointLight.cpp
@@ -13,7 +13,7 @@ namespace Siege
 
 PointLight::PointLight() : PointLight(Vec3::Zero, {1.0f, 1.0f, 1.0f, 0.2f}, {1.f, 1.f, 1.f, .2f}) {}
 
-PointLight::PointLight(Vec3 position, Vec4 color, Vec4 ambientColor) :
+PointLight::PointLight(Vec3 position, FColour color, FColour ambientColor) :
     lightData {color, ambientColor, position}
 {}
 
diff --git a/engine/render/renderer/lights/PointLight.h b/engine/render/renderer/lights/PointLight.h
@@ -21,13 +21,13 @@ class PointLight
 
     struct Data
     {
-        Vec4 lightColor = {1.f, 1.f, 1.f, 0.2f};
-        alignas(16) Vec4 ambientLightColor = {1.f, 1.f, 1.f, .02f};
+        FColour lightColor = {1.f, 1.f, 1.f, 0.2f};
+        alignas(16) FColour ambientLightColor = {1.f, 1.f, 1.f, .02f};
         alignas(16) Vec3 position = Vec3::Zero;
     };
 
     PointLight();
-    PointLight(Vec3 position, Vec4 color, Vec4 ambientColor);
+    PointLight(Vec3 position, FColour color, FColour ambientColor);
     ~PointLight();
 
     Data& GetLightData()
@@ -42,11 +42,11 @@ class PointLight
     {
         lightData.position = position;
     }
-    void SetColor(Vec4 color)
+    void SetColor(FColour color)
     {
         lightData.lightColor = color;
     }
-    void SetAmbientColor(Vec4 ambientColor)
+    void SetAmbientColor(FColour ambientColor)
     {
         lightData.ambientLightColor = ambientColor;
     }
diff --git a/engine/render/renderer/mesh/Mesh.h b/engine/render/renderer/mesh/Mesh.h
@@ -9,6 +9,8 @@
 #ifndef SIEGE_ENGINE_MESH_H
 #define SIEGE_ENGINE_MESH_H
 
+#include <utils/Colour.h>
+
 #include "../Core.h"
 #include "../buffer/Buffer.h"
 #include "render/renderer/platform/vulkan/CommandBuffer.h"
@@ -18,15 +20,15 @@ namespace Siege
 struct Vertex
 {
     Vec3 position;
-    Vec3 color;
+    FColour color;
     Vec3 normal;
     Vec2 uv;
 };
 
 struct Vertex2D
 {
     Vec2 position;
-    Vec3 color;
+    FColour color;
 };
 
 struct BillboardVertex
diff --git a/engine/render/renderer/model/Model.cpp b/engine/render/renderer/model/Model.cpp
@@ -120,9 +120,10 @@ void Model::LoadModelFromFile(const String& filePath)
                                         attrib.vertices[3 * index.vertex_index + 1],
                                         attrib.vertices[3 * index.vertex_index + 2]};
 
-                vertex.color = Vec3 {attrib.colors[3 * index.vertex_index + 0],
-                                     attrib.colors[3 * index.vertex_index + 1],
-                                     attrib.colors[3 * index.vertex_index + 2]};
+                vertex.color = FColour {attrib.colors[3 * index.vertex_index + 0],
+                                        attrib.colors[3 * index.vertex_index + 1],
+                                        attrib.colors[3 * index.vertex_index + 2],
+                                        1.f};
             }
 
             if (index.normal_index >= 0)
diff --git a/engine/render/renderer/renderer/BillboardRenderer.cpp b/engine/render/renderer/renderer/BillboardRenderer.cpp
@@ -45,12 +45,15 @@ void BillboardRenderer::Destroy()
     billboardModel.DestroyModel();
 }
 
-void BillboardRenderer::DrawBillboard(const Vec3& position, const Vec2& scale, const Vec4& colour)
+void BillboardRenderer::DrawBillboard(const Vec3& position,
+                                      const Vec2& scale,
+                                      const IColour& colour)
 {
-    vertices.Append({{1.f, 1.f, 1.f}, colour});
-    vertices.Append({{1.f, -1.f, 1.f}, colour});
-    vertices.Append({{-1.f, -1.f, 1.f}, colour});
-    vertices.Append({{-1.f, 1.f, 1.f}, colour});
+    auto fColour = ToFColour(colour);
+    vertices.Append({{1.f, 1.f, 1.f}, fColour});
+    vertices.Append({{1.f, -1.f, 1.f}, fColour});
+    vertices.Append({{-1.f, -1.f, 1.f}, fColour});
+    vertices.Append({{-1.f, 1.f, 1.f}, fColour});
 
     // Pattern: 0, 1, 3, 1, 2, 3
     indices.Append(vertices.Count() - 4);
diff --git a/engine/render/renderer/renderer/BillboardRenderer.h b/engine/render/renderer/renderer/BillboardRenderer.h
@@ -9,6 +9,8 @@
 #ifndef SIEGE_ENGINE_BILLBOARD_RENDERER_H
 #define SIEGE_ENGINE_BILLBOARD_RENDERER_H
 
+#include <utils/Colour.h>
+
 #include "../Core.h"
 #include "../model/Model.h"
 
@@ -24,7 +26,7 @@ class BillboardRenderer
     void Initialise(const String& globalDataAttributeName, const uint64_t& globalDataSize);
     void Destroy();
 
-    void DrawBillboard(const Vec3& position, const Vec2& scale, const Vec4& colour);
+    void DrawBillboard(const Vec3& position, const Vec2& scale, const IColour& colour);
 
     void Render(Vulkan::CommandBuffer& commandBuffer,
                 const uint64_t& globalDataSize,
@@ -39,7 +41,7 @@ class BillboardRenderer
     struct BillboardVertex
     {
         Vec3 position;
-        Vec4 colour;
+        FColour colour;
     };
 
     struct BillboardUBO
diff --git a/engine/render/renderer/renderer/DebugRenderer3D.cpp b/engine/render/renderer/renderer/DebugRenderer3D.cpp
@@ -47,10 +47,11 @@ void DebugRenderer3D::RecreateMaterials()
 }
 
 // Wire primitives
-void DebugRenderer3D::DrawLine(const Vec3& origin, const Vec3& destination, const Vec4& colour)
+void DebugRenderer3D::DrawLine(const Vec3& origin, const Vec3& destination, const IColour& colour)
 {
-    lines.Append({origin, colour});
-    lines.Append({destination, colour});
+    auto fColour = ToFColour(colour);
+    lines.Append({origin, fColour});
+    lines.Append({destination, fColour});
 }
 
 void DebugRenderer3D::Flush()
diff --git a/engine/render/renderer/renderer/DebugRenderer3D.h b/engine/render/renderer/renderer/DebugRenderer3D.h
@@ -25,9 +25,8 @@ class DebugRenderer3D
     void Destroy();
 
     // Wire primitives
-    void DrawLine(const Siege::Vec3& origin,
-                  const Siege::Vec3& destination,
-                  const Siege::Vec4& colour);
+    void DrawLine(const Vec3& origin, const Vec3& destination, const IColour& colour);
+    void DrawCube(const Vec3& position, const Vec3& rotation, const Vec3& scale);
 
     void Render(Vulkan::CommandBuffer& commandBuffer,
                 const uint64_t& globalDataSize,
@@ -42,7 +41,7 @@ class DebugRenderer3D
     struct LineVertex
     {
         Vec3 position;
-        Vec4 colour;
+        FColour colour;
     };
 
     void RenderLines(Vulkan::CommandBuffer& commandBuffer,
diff --git a/engine/render/renderer/renderer/LightRenderer.cpp b/engine/render/renderer/renderer/LightRenderer.cpp
@@ -39,8 +39,8 @@ void LightRenderer::Destroy()
 
 void LightRenderer::DrawPointLight(const Vec3& position,
                                    float radius,
-                                   const Vec4& colour,
-                                   const Vec4& ambientColor)
+                                   const IColour& colour,
+                                   const IColour& ambientColor)
 {
     pointLightVertices.Append({1.f, 1.f});
     pointLightVertices.Append({1.f, -1.f});
diff --git a/engine/render/renderer/renderer/LightRenderer.h b/engine/render/renderer/renderer/LightRenderer.h
@@ -24,8 +24,8 @@ class LightRenderer
 
     void DrawPointLight(const Vec3& position,
                         float radius,
-                        const Vec4& colour,
-                        const Vec4& ambientColor);
+                        const IColour& colour,
+                        const IColour& ambientColor);
 
     void Render(Vulkan::CommandBuffer& commandBuffer,
                 const uint64_t& globalDataSize,
diff --git a/engine/render/renderer/renderer/Renderer3D.cpp b/engine/render/renderer/renderer/Renderer3D.cpp
@@ -39,7 +39,7 @@ void Renderer3D::Initialise()
         Vulkan::Shader::Builder().FromFragmentShader("assets/shaders/grid.frag.spv").Build());
 }
 
-void Renderer3D::DrawBillboard(const Vec3& position, const Vec2& scale, const Vec4& colour)
+void Renderer3D::DrawBillboard(const Vec3& position, const Vec2& scale, const IColour& colour)
 {
     billboardRenderer.DrawBillboard(position, scale, colour);
 }
@@ -62,12 +62,12 @@ void Renderer3D::DrawModel(Model* model, const Vec3& position)
     DrawModel(model, position, Vec3::One, Vec3::Zero);
 }
 
-void Renderer3D::DrawPointLight(const Siege::Vec3& position,
-                                const float& radius,
-                                const Siege::Vec4& colour,
-                                const Siege::Vec4& ambientColor)
+void Renderer3D::DrawPointLight(const Vec3& position,
+                                float radius,
+                                const IColour& colour,
+                                const IColour& ambientColor)
 {
-    global3DData.lightData = {colour, ambientColor, position};
+    global3DData.lightData = {ToFColour(colour), ToFColour(ambientColor), position};
 
     lightRenderer.DrawPointLight(position, 0.05f, colour, ambientColor);
 }
@@ -87,7 +87,7 @@ void Renderer3D::Render(Vulkan::CommandBuffer& commandBuffer, const CameraData&
 #endif
 }
 
-void Renderer3D::DrawLine(const Vec3& origin, const Vec3& destination, const Vec4& colour)
+void Renderer3D::DrawLine(const Vec3& origin, const Vec3& destination, const IColour& colour)
 {
     debugRenderer.DrawLine(origin, destination, colour);
 }
diff --git a/engine/render/renderer/renderer/Renderer3D.h b/engine/render/renderer/renderer/Renderer3D.h
@@ -41,18 +41,16 @@ class Renderer3D
     static void DrawModel(Model* model, const Vec3& position, const Vec3& scale);
     static void DrawModel(Model* model, const Vec3& position);
 
-    static void DrawBillboard(const Vec3& position, const Vec2& scale, const Vec4& colour);
+    static void DrawBillboard(const Vec3& position, const Vec2& scale, const IColour& colour);
 
     // Debug rendering
     // TODO(Aryeh): Move this to it's own renderer module?
-    static void DrawLine(const Siege::Vec3& origin,
-                         const Siege::Vec3& destination,
-                         const Siege::Vec4& colour);
-
-    static void DrawPointLight(const Siege::Vec3& position,
-                               const float& radius,
-                               const Siege::Vec4& colour,
-                               const Siege::Vec4& ambientColor);
+    static void DrawLine(const Vec3& origin, const Vec3& destination, const IColour& colour);
+
+    static void DrawPointLight(const Vec3& position,
+                               float radius,
+                               const IColour& colour,
+                               const IColour& ambientColor);
 
     static void RecreateMaterials();
 
diff --git a/engine/utils/Colour.cpp b/engine/utils/Colour.cpp
@@ -6,8 +6,5 @@
 //     https://opensource.org/licenses/Zlib
 //
 
-#include "Colour.h"
-
 namespace Siege
-{
-} // namespace Siege
+{} // namespace Siege
diff --git a/engine/utils/Colour.h b/engine/utils/Colour.h
@@ -12,6 +12,8 @@
 #include <cstdint>
 #include <type_traits>
 
+#include "Hash.h"
+
 namespace Siege
 {
 template<typename T, typename std::enable_if<std::is_arithmetic<T>::value>::type* = nullptr>
@@ -43,9 +45,29 @@ struct Colour
         r {static_cast<T>(other.r)},
         g {static_cast<T>(other.g)},
         b {static_cast<T>(other.b)},
-        a {static_cast<T>(other.a )}
+        a {static_cast<T>(other.a)}
     {}
 
+    inline constexpr bool operator==(const FColour& other) const
+    {
+        return r == other.r && g == other.g && b == other.b && a == other.a;
+    }
+
+    inline constexpr bool operator==(const IColour& other) const
+    {
+        return r == other.r && g == other.g && b == other.b && a == other.a;
+    }
+
+    inline constexpr bool operator!=(const FColour& other) const
+    {
+        return r == other.r || g == other.g || b == other.b || a == other.a;
+    }
+
+    inline constexpr bool operator!=(const IColour& other) const
+    {
+        return r == other.r || g == other.g || b == other.b || a == other.a;
+    }
+
     // Public members
 
     T r {0};
@@ -72,6 +94,49 @@ inline constexpr IColour IGreen = {0, 255, 0, 255};
 inline constexpr IColour IBlue = {0, 0, 255, 255};
 inline constexpr IColour IPink = {255, 109, 194, 255};
 
+// Conversion functions
+
+inline constexpr FColour ToFColour(const IColour& other)
+{
+    return {(static_cast<float>(other.r) - 0.f) / (255.f - 0.f),
+            (static_cast<float>(other.g) - 0.f) / (255.f - 0.f),
+            (static_cast<float>(other.b) - 0.f) / (255.f - 0.f),
+            (static_cast<float>(other.a) - 0.f) / (255.f - 0.f)};
+}
+
+inline constexpr FColour ToIColour(const FColour& other)
+{
+    return {static_cast<float>(other.r * 255),
+            static_cast<float>(other.g * 255),
+            static_cast<float>(other.b * 255),
+            static_cast<float>(other.a * 255)};
+}
+
 } // namespace Siege
 
+namespace std
+{
+template<>
+struct ::std::hash<Siege::FColour>
+{
+    size_t operator()(const Siege::FColour& colour) const
+    {
+        size_t seed = 0;
+        Siege::Hash::HashCombine(seed, colour.r, colour.g, colour.b, colour.a);
+        return seed;
+    };
+};
+
+template<>
+struct ::std::hash<Siege::IColour>
+{
+    size_t operator()(const Siege::IColour& colour) const
+    {
+        size_t seed = 0;
+        Siege::Hash::HashCombine(seed, colour.r, colour.g, colour.b, colour.a);
+        return seed;
+    };
+};
+} // namespace std
+
 #endif // SIEGE_ENGINE_COLOUR_H
diff --git a/examples/render/src/GameObject.cpp b/examples/render/src/GameObject.cpp
@@ -14,7 +14,7 @@ GameObject::GameObject(Siege::Model* model) : model {model} {}
 
 GameObject::~GameObject() {}
 
-void GameObject::SetColor(const Siege::Vec3& newColor)
+void GameObject::SetColour(const Siege::IColour& newColor)
 {
     fillColor = newColor;
 }
diff --git a/examples/render/src/GameObject.h b/examples/render/src/GameObject.h
@@ -31,7 +31,7 @@ class GameObject
 
     ~GameObject();
 
-    Siege::Vec3& GetColor()
+    Siege::IColour& GetColor()
     {
         return fillColor;
     }
@@ -93,7 +93,7 @@ class GameObject
         return transform.GetRotation().z;
     }
 
-    void SetColor(const Siege::Vec3& newColor);
+    void SetColour(const Siege::IColour& newColor);
     void SetScale(const Siege::Vec3& newScale);
     void SetPosition(const Siege::Vec3& newPos);
     void SetRotation(const Siege::Vec3& rotation);
@@ -110,6 +110,6 @@ class GameObject
 
     Siege::Xform transform {};
     Siege::Model* model;
-    Siege::Vec3 fillColor {};
+    Siege::IColour fillColor {};
 };
 #endif
diff --git a/examples/render/src/main.cpp b/examples/render/src/main.cpp
diff --git a/tests/utils/test_Colour.cpp b/tests/utils/test_Colour.cpp

Original file line number	Diff line number	Diff line change
`@@ -21,13 +21,13 @@ class PointLight`
`21`	`21`
`22`	`22`	`struct Data`
`23`	`23`	`{`
`24`		`- Vec4 lightColor = {1.f, 1.f, 1.f, 0.2f};`
`25`		`- alignas(16) Vec4 ambientLightColor = {1.f, 1.f, 1.f, .02f};`
	`24`	`+ FColour lightColor = {1.f, 1.f, 1.f, 0.2f};`
	`25`	`+ alignas(16) FColour ambientLightColor = {1.f, 1.f, 1.f, .02f};`
`26`	`26`	`alignas(16) Vec3 position = Vec3::Zero;`
`27`	`27`	`};`
`28`	`28`
`29`	`29`	`PointLight();`
`30`		`- PointLight(Vec3 position, Vec4 color, Vec4 ambientColor);`
	`30`	`+ PointLight(Vec3 position, FColour color, FColour ambientColor);`
`31`	`31`	`~PointLight();`
`32`	`32`
`33`	`33`	`Data& GetLightData()`
`@@ -42,11 +42,11 @@ class PointLight`
`42`	`42`	`{`
`43`	`43`	`lightData.position = position;`
`44`	`44`	`}`
`45`		`- void SetColor(Vec4 color)`
	`45`	`+ void SetColor(FColour color)`
`46`	`46`	`{`
`47`	`47`	`lightData.lightColor = color;`
`48`	`48`	`}`
`49`		`- void SetAmbientColor(Vec4 ambientColor)`
	`49`	`+ void SetAmbientColor(FColour ambientColor)`
`50`	`50`	`{`
`51`	`51`	`lightData.ambientLightColor = ambientColor;`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,10 +47,11 @@ void DebugRenderer3D::RecreateMaterials()`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`// Wire primitives`
`50`		`-void DebugRenderer3D::DrawLine(const Vec3& origin, const Vec3& destination, const Vec4& colour)`
	`50`	`+void DebugRenderer3D::DrawLine(const Vec3& origin, const Vec3& destination, const IColour& colour)`
`51`	`51`	`{`
`52`		`- lines.Append({origin, colour});`
`53`		`- lines.Append({destination, colour});`
	`52`	`+ auto fColour = ToFColour(colour);`
	`53`	`+ lines.Append({origin, fColour});`
	`54`	`+ lines.Append({destination, fColour});`
`54`	`55`	`}`
`55`	`56`
`56`	`57`	`void DebugRenderer3D::Flush()`