using engine types

Reviewed-on: #80

CMakeLists.txt

@@ -5,7 +5,7 @@ set(NAME sophia)
 project(${NAME} VERSION 0.0.0)
 
 enable_language(CXX)
-set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD 23)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 

editor/CMakeLists.txt

@@ -10,7 +10,7 @@ target_link_libraries(${NAME}_deps INTERFACE
   imguizmo
 )
 
-target_compile_features(${PROJECT_NAME} PUBLIC cxx_std_17)
+target_compile_features(${PROJECT_NAME} PUBLIC cxx_std_23)
 set_property(TARGET ${PROJECT_NAME} PROPERTY VS_DEBUGGER_WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}/build")
 
 add_executable(editor ${SOURCES})

editor/utilities/logger.hpp

@@ -1,8 +1,13 @@
 #pragma once
 
+#include <format>
 #include <sophia/util/logger.hpp>
+#include <utility>
 
 template <typename... Args>
-void log(Args... args) {
-  sophia::log::print("\033[1;38;2;170;90;255m[editor]\033[0m", args...);
+void log(std::format_string<Args...> fmt, Args&&... args) {
+  if constexpr (sophia::log::enabled) {
+    sophia::log::print("\033[1;38;2;170;90;255m[editor]\033[0m {}",
+                       std::format(fmt, std::forward<Args>(args)...));
+  }
 }

engine/include/sophia/components.hpp

@@ -11,7 +11,7 @@ namespace sophia {
 
 struct TagComponent {
   std::string tag;  // entt::hashed_string ?
-  uint32_t mask = 0;
+  u32 mask = 0;
 };
 
 struct TransformComponent {
@@ -100,7 +100,7 @@ struct CameraComponent {
     float farPlane = 100.f;
   };
 
-  enum class Projection { Orthographic, Perspective };
+  enum class Projection : u8 { Orthographic, Perspective };
 
   Projection projection = Projection::Orthographic;
   Orthographic ortho;

engine/include/sophia/event.hpp

@@ -83,7 +83,7 @@ class EventSystem {
       this->eventDelegates[eventType] =
           std::make_unique<std::any>(EventDelegate<E>());
 
-      log::trace("EventSystem creating new event type: ", eventType);
+      log::trace("EventSystem creating new event type: {}", eventType);
     }
 
     EventDelegate<E>& delegate =
@@ -102,7 +102,7 @@ class EventSystem {
       this->eventDelegates[eventType] =
           std::make_unique<std::any>(EventDelegate<E>());
 
-      log::trace("EventSystem creating new event type: ", eventType);
+      log::trace("EventSystem creating new event type: {}", eventType);
     }
 
     EventDelegate<E>& delegate =
@@ -124,12 +124,14 @@ class EventSystem {
           std::any_cast<EventDelegate<E>&>(*this->eventDelegates.at(eventType));
       delegate.invoke(event);
     } catch (const std::out_of_range& error) {
-      log::error("event dispatch failed: ", event.toString());
+      log::error("event dispatch failed: {}", event.toString());
     }
   }
 
  private:
-  EventSystem() { log::info("EventSystem Initialized: ", this); }
+  EventSystem() {
+    log::info("EventSystem Initialized: {}", static_cast<const void*>(this));
+  }
   ~EventSystem() { log::info("EventSystem Destroyed"); }
 
   std::unordered_map<EventType, std::unique_ptr<std::any>> eventDelegates;

engine/include/sophia/ui/panel_registry.hpp

@@ -38,7 +38,7 @@ class PanelRegistry {
   const T& get(PanelHandle handle) const {
     const Panel& panel = get(handle);
     SOPHIA_ASSERT(dynamic_cast<const T*>(&panel) != nullptr,
-                  "PanelHandle does not refer to a", typeid(T).name());
+                  "PanelHandle does not refer to a {}", typeid(T).name());
     return static_cast<const T&>(panel);
   }
 

engine/include/sophia/util/assert.hpp

@@ -1,7 +1,9 @@
 /**
  * Usage:
  * SOPHIA_ASSERT(pipelineLayout != nullptr);
- * SOPHIA_ASSERT(index < count, "index", index, "out of bounds:", count);
+ * SOPHIA_ASSERT(index < count, "index {} out of bounds: {}", index, count);
+ *
+ * The optional message is a std::format string, checked at compile time.
  *
  * Compiled out entirely in release (NDEBUG) builds, matching <cassert>'s
  * assert() semantics: don't rely on side effects inside the condition.
@@ -10,16 +12,18 @@
 #pragma once
 
 #include <cstdlib>
+#include <format>
 #include <sophia/util/logger.hpp>
 
 #ifndef NDEBUG
-#define SOPHIA_ASSERT(condition, ...)                                       \
-  do {                                                                      \
-    if (!(condition)) {                                                     \
-      ::sophia::log::fatal("Assertion failed:", #condition, "at", __FILE__, \
-                           ":", __LINE__ __VA_OPT__(, ) __VA_ARGS__);       \
-      std::abort();                                                         \
-    }                                                                       \
+#define SOPHIA_ASSERT(condition, ...)                                      \
+  do {                                                                     \
+    if (!(condition)) {                                                    \
+      ::sophia::log::fatal(                                                \
+          "Assertion failed: {} at {}:{}" __VA_OPT__(" - {}"), #condition, \
+          __FILE__, __LINE__ __VA_OPT__(, ::std::format(__VA_ARGS__)));    \
+      std::abort();                                                        \
+    }                                                                      \
   } while (false)
 #else
 #define SOPHIA_ASSERT(condition, ...) ((void)0)

engine/include/sophia/util/delegate.hpp

@@ -2,13 +2,12 @@
 
 #include <functional>
 #include <memory>
+#include <sophia/util/logger.hpp>
 #include <stdexcept>
 #include <string>
 #include <typeinfo>
 #include <vector>
 
-#include <sophia/util/logger.hpp>
-
 #define DEFAULT_DELEGATE_FUNCTOR_ALLOC 5
 
 namespace sophia {
@@ -39,7 +38,9 @@ class expired_weak_object : public std::runtime_error {
 template <class O, typename... A>
 std::function<void(A...)> createWeakFunction(void (O::*method)(A...),
                                              std::shared_ptr<O> obj) {
-  if (!obj) { throw std::invalid_argument("method and obj must not be null"); }
+  if (!obj) {
+    throw std::invalid_argument("method and obj must not be null");
+  }
 
   std::weak_ptr<O> weakObj = obj;
 
@@ -82,7 +83,7 @@ class Delegate {
         try {
           this->functors[i](std::forward<A>(args)...);
         } catch (const expired_weak_object& e) {
-          log::error("delegate invoke error: ", e.what());
+          log::error("delegate invoke error: {}", e.what());
           deadFunctorIndexs.push_back(i);
         }
       }
@@ -97,7 +98,9 @@ class Delegate {
   void operator=(Functor c) {
     clear();
 
-    if (c != nullptr) { add(c); }
+    if (c != nullptr) {
+      add(c);
+    }
   }
 
   void operator+=(Functor c) { add(c); }

engine/include/sophia/util/logger.hpp

@@ -1,23 +1,36 @@
 /**
- * Lots of work still needs to be done in here.
+ * std::format-style logging. Format strings are checked at compile time.
  *
  * Usage:
  * using namespace sophia;
- * log::fatal("fatal message")
- * log::info("Infomation message")
+ * log::fatal("failed to load {}", path)
+ * log::info("loaded {} meshes in {:.2f}ms", count, ms)
+ * log::debug("value: {}", x)  // prefixed with file:line
  * log::print("no prefix, just the message")
  *
+ * Everything is compiled out in release (NDEBUG) builds.
+ *
  * TODO Impl some form of log error handling
  */
 
 #pragma once
 
-#include <iostream>
-#include <sophia/types.hpp>
+#include <cstdio>
+#include <format>
+#include <print>
+#include <source_location>
+#include <string_view>
+#include <type_traits>
 #include <utility>
 
 namespace sophia::log {
 
+#ifndef NDEBUG
+inline constexpr bool enabled = true;
+#else
+inline constexpr bool enabled = false;
+#endif  // !NDEBUG
+
 enum class LEVEL {
   NONE,
   FATAL,
@@ -29,118 +42,113 @@ enum class LEVEL {
   TRACE,
 };
 
-// Helper print functions
-#define LOG_PRINT_HELPER(MSG) std::cout << MSG
-#define LOG_PREFIX_FATAL LOG_PRINT_HELPER("\033[1;91m[FATAL]\033[0m ")
-#define LOG_PREFIX_ERROR LOG_PRINT_HELPER("\033[1;31m[ERROR]\033[0m ")
-#define LOG_PREFIX_WARNING LOG_PRINT_HELPER("\033[1;33m[WARNING]\033[0m ")
-#define LOG_PREFIX_INFO LOG_PRINT_HELPER("\033[32m[INFO]\033[0m ")
-#define LOG_PREFIX_VERBOSE LOG_PRINT_HELPER("\033[36m[VERBOSE]\033[0m ")
-#define LOG_PREFIX_DEBUG LOG_PRINT_HELPER("\033[1;34m[DEBUG]\033[0m ")
-#define LOG_PREFIX_TRACE LOG_PRINT_HELPER("\033[1;90m[TRACE]\033[0m ")
+namespace detail {
 
-template <typename... Args>
-void log(LEVEL level = LEVEL::NONE, Args... args) {
-#ifndef NDEBUG
+constexpr std::string_view prefix(LEVEL level) {
   switch (level) {
     case LEVEL::FATAL:
-      LOG_PREFIX_FATAL;
-      break;
+      return "\033[1;91m[FATAL]\033[0m ";
     case LEVEL::ERROR:
-      LOG_PREFIX_ERROR;
-      break;
+      return "\033[1;31m[ERROR]\033[0m ";
     case LEVEL::WARNING:
-      LOG_PREFIX_WARNING;
-      break;
+      return "\033[1;33m[WARNING]\033[0m ";
     case LEVEL::INFO:
-      LOG_PREFIX_INFO;
-      break;
+      return "\033[32m[INFO]\033[0m ";
     case LEVEL::VERBOSE:
-      LOG_PREFIX_VERBOSE;
-      break;
-    // case LEVEL::DEBUGGING:
-    //     LOG_PREFIX_DEBUG;
-    //     break;
+      return "\033[36m[VERBOSE]\033[0m ";
+    case LEVEL::DEBUGGING:
+      return "\033[1;34m[DEBUG]\033[0m ";
     case LEVEL::TRACE:
-      LOG_PREFIX_TRACE;
-      break;
+      return "\033[1;90m[TRACE]\033[0m ";
     default:
-      std::cout << "\033[1;90m[LOG]\033[0m ";
-      break;
+      return "\033[1;90m[LOG]\033[0m ";
   }
+}
 
-  ((std::cout << ' ' << std::forward<Args>(args)), ...);
-  std::cout << std::endl;
-#else
-  (void)level;
-  (void)std::initializer_list<int>{((void)args, 0)...};
-#endif  // !NDEBUG
+inline void write(std::string_view prefix, std::string_view message) {
+  std::println(stdout, "{}{}", prefix, message);
+  std::fflush(stdout);
+}
+
+// Captures the caller's location alongside the format string, since a
+// defaulted std::source_location parameter can't follow a parameter pack.
+template <typename... Args>
+struct FormatWithLocation {
+  std::format_string<Args...> fmt;
+  std::source_location location;
+
+  template <typename S>
+    requires std::is_convertible_v<const S&, std::string_view>
+  consteval FormatWithLocation(
+      const S& fmt,
+      std::source_location location = std::source_location::current())
+      : fmt(fmt), location(location) {}
+};
+
+}  // namespace detail
+
+template <typename... Args>
+void log(LEVEL level, std::format_string<Args...> fmt, Args&&... args) {
+  if constexpr (enabled) {
+    detail::write(detail::prefix(level),
+                  std::format(fmt, std::forward<Args>(args)...));
+  }
 }
 
 template <typename... Args>
-void fatal(Args... args) {
-  log(LEVEL::FATAL, args...);
+void fatal(std::format_string<Args...> fmt, Args&&... args) {
+  log(LEVEL::FATAL, fmt, std::forward<Args>(args)...);
 }
 
 template <typename... Args>
-void error(Args... args) {
-  log(LEVEL::ERROR, args...);
+void error(std::format_string<Args...> fmt, Args&&... args) {
+  log(LEVEL::ERROR, fmt, std::forward<Args>(args)...);
 }
 
 template <typename... Args>
-void warning(Args... args) {
-  log(LEVEL::WARNING, args...);
+void warning(std::format_string<Args...> fmt, Args&&... args) {
+  log(LEVEL::WARNING, fmt, std::forward<Args>(args)...);
 }
 
 template <typename... Args>
-void info(Args... args) {
-  log(LEVEL::INFO, args...);
+void info(std::format_string<Args...> fmt, Args&&... args) {
+  log(LEVEL::INFO, fmt, std::forward<Args>(args)...);
 }
 
 template <typename... Args>
-void verbose(Args... args) {
-  log(LEVEL::VERBOSE, args...);
+void verbose(std::format_string<Args...> fmt, Args&&... args) {
+  log(LEVEL::VERBOSE, fmt, std::forward<Args>(args)...);
 }
 
 template <typename... Args>
-void debug(const char* file, u16 line, Args... args) {
-#ifndef NDEBUG
-  LOG_PREFIX_DEBUG;
-  std::cout << file << "::" << line;
-  ((std::cout << ' ' << std::forward<Args>(args)), ...);
-  std::cout << std::endl;
-#else
-  (void)file;
-  (void)line;
-  (void)std::initializer_list<int>{((void)args, 0)...};
-#endif  // !NDEBUG
+void debug(detail::FormatWithLocation<std::type_identity_t<Args>...> fmt,
+           Args&&... args) {
+  if constexpr (enabled) {
+    detail::write(
+        detail::prefix(LEVEL::DEBUGGING),
+        std::format("{}:{} {}", fmt.location.file_name(), fmt.location.line(),
+                    std::format(fmt.fmt, std::forward<Args>(args)...)));
+  }
 }
-// trick
-#define debug(...) debug(__FILE__, __LINE__, __VA_ARGS__)
 
 template <typename... Args>
-void trace(Args... args) {
-  log(LEVEL::TRACE, args...);
+void trace(std::format_string<Args...> fmt, Args&&... args) {
+  log(LEVEL::TRACE, fmt, std::forward<Args>(args)...);
 }
 
-// Like the functions above, but with no "[LEVEL]" prefix: just the arguments,
-// separated by spaces, then a newline. With none, an empty line.
+// Like the functions above, but with no "[LEVEL]" prefix. With no arguments,
+// an empty line.
 inline void print() {
-#ifndef NDEBUG
-  std::cout << std::endl;
-#endif  // !NDEBUG
+  if constexpr (enabled) {
+    detail::write("", "");
+  }
 }
 
-template <typename First, typename... Rest>
-void print(First first, Rest... rest) {
-#ifndef NDEBUG
-  std::cout << first;
-  ((std::cout << ' ' << rest), ...);
-  std::cout << std::endl;
-#else
-  (void)first;
-  (void)std::initializer_list<int>{((void)rest, 0)...};
-#endif  // !NDEBUG
+template <typename... Args>
+void print(std::format_string<Args...> fmt, Args&&... args) {
+  if constexpr (enabled) {
+    detail::write("", std::format(fmt, std::forward<Args>(args)...));
+  }
 }
 
 }  // namespace sophia::log

engine/include/sophia/util/pool.hpp

@@ -111,15 +111,12 @@ class Pool {
   };
 
   const Slot& validate(Handle<T> handle) const {
-    SOPHIA_ASSERT(handle.isValid(), "invalid handle:", name);
-    SOPHIA_ASSERT(handle.index < slots.size(), name,
-                  "handle index out of range:", handle.index);
+    SOPHIA_ASSERT(handle.isValid(), "invalid handle: {}", name);
+    SOPHIA_ASSERT(handle.index < slots.size(), "{} handle index out of range: {}", name, static_cast<u32>(handle.index));
 
     const Slot& slot = slots[handle.index];
-    SOPHIA_ASSERT(slot.generation == handle.generation, "stale", name,
-                  "handle (generation mismatch):", handle.index);
-    SOPHIA_ASSERT(slot.item != nullptr, name,
-                  "handle refers to a released item:", handle.index);
+    SOPHIA_ASSERT(slot.generation == handle.generation, "stale {} handle (generation mismatch): {}", name, static_cast<u32>(handle.index));
+    SOPHIA_ASSERT(slot.item != nullptr, "{} handle refers to a released item: {}", name, static_cast<u32>(handle.index));
     return slot;
   }
 

engine/src/application.cpp

@@ -35,17 +35,6 @@ namespace sophia {
 
 namespace {
 
-struct Vertex {
-  glm::vec2 position;
-  glm::vec3 color;
-};
-
-struct PushConstants {
-  glm::mat4 transform;
-  glm::vec4 color;
-  glm::vec4 data;
-};
-
 std::vector<std::string> commandLineArgs;
 
 constexpr ClearColor CLEAR_COLOR = {0.01f, 0.01f, 0.02f, 1.0f};
@@ -287,7 +276,7 @@ class Application::Impl {
     auto endTime = std::chrono::high_resolution_clock::now();
     double totalRuntime =
         std::chrono::duration<double>(endTime - startTime).count();
-    log::info("Application ran for", totalRuntime, "s");
+    log::info("Application ran for {:.2f}s", totalRuntime);
   }
 
   void pushMesh(std::vector<CanvasVertex> vertices, std::vector<u32> indices) {

engine/src/renderer/mesh_render_system.cpp

@@ -43,8 +43,9 @@ void MeshRenderSystem::render(vk::CommandBuffer commandBuffer,
 
   u32 available = MAX_INSTANCES_PER_FRAME - this->instanceCursor;
   if (instances.size() > available) {
-    log::warning("MeshRenderSystem: frame instance buffer full, dropping",
-                 instances.size() - available, "meshes");
+    log::warning(
+        "MeshRenderSystem: frame instance buffer full, dropping {} meshes",
+        instances.size() - available);
   }
 
   Buffer& buffer = *this->instanceBuffers[this->frameIndex];

engine/src/renderer/render_context.cpp

@@ -38,7 +38,7 @@ vk::CommandBuffer RenderContext::beginFrame() {
   }
 
   if (fenceResult != vk::Result::eSuccess) {
-    log::error("failed to wait for fence: " + vk::to_string(fenceResult));
+    log::error("failed to wait for fence: {}", vk::to_string(fenceResult));
   }
 
   vk::Semaphore imageAvailable = frame.imageAvailable.get();
@@ -62,7 +62,7 @@ vk::CommandBuffer RenderContext::beginFrame() {
         imageInFlight, vk::True, std::numeric_limits<u64>::max());
 
     if (fenceResult != vk::Result::eSuccess) {
-      log::error("failed to wait for fence: " + vk::to_string(fenceResult));
+      log::error("failed to wait for fence: {}", vk::to_string(fenceResult));
     }
   }
 

engine/src/renderer/render_graph.cpp

@@ -106,8 +106,8 @@ void RenderGraph::recordRendering(vk::CommandBuffer commandBuffer, Pass& pass) {
     const Image& image = *this->images[color.image.index].image;
     SOPHIA_ASSERT(image.getExtent().width == extent.width &&
                       image.getExtent().height == extent.height,
-                  "Pass", pass.name,
-                  "has color attachments of different sizes");
+                  "Pass {} has color attachments of different sizes",
+                  pass.name);
 
     vk::RenderingAttachmentInfo attachment{};
     attachment.imageView = image.getView();
@@ -129,8 +129,8 @@ void RenderGraph::recordRendering(vk::CommandBuffer commandBuffer, Pass& pass) {
     const Image& image = *this->images[pass.depthAttachment->image.index].image;
     SOPHIA_ASSERT(image.getExtent().width == extent.width &&
                       image.getExtent().height == extent.height,
-                  "Pass", pass.name,
-                  "has a depth attachment of a different size");
+                  "Pass {} has a depth attachment of a different size",
+                  pass.name);
 
     depthAttachment.imageView = image.getView();
     depthAttachment.imageLayout =
@@ -168,8 +168,8 @@ RenderGraph::PassBuilder& RenderGraph::PassBuilder::writeColor(
 
 RenderGraph::PassBuilder& RenderGraph::PassBuilder::writeDepth(
     ImageRef image, vk::AttachmentLoadOp loadOp, float clearDepth) {
-  SOPHIA_ASSERT(!this->pass.depthAttachment, "Pass", this->pass.name,
-                "already has a depth attachment");
+  SOPHIA_ASSERT(!this->pass.depthAttachment,
+                "Pass {} already has a depth attachment", this->pass.name);
   this->use(image, Access::DepthWrite);
   this->pass.depthAttachment = DepthAttachment{image, loadOp, clearDepth};
   return *this;
@@ -184,8 +184,8 @@ RenderGraph::PassBuilder& RenderGraph::PassBuilder::use(ImageRef image,
   SOPHIA_ASSERT(image.isValid() && image.index < this->graph.images.size(),
                 "ImageRef doesn't belong to this graph");
   for (const ImageUse& existing : this->pass.uses) {
-    SOPHIA_ASSERT(existing.image.index != image.index, "Pass", this->pass.name,
-                  "uses the same image twice");
+    SOPHIA_ASSERT(existing.image.index != image.index,
+                  "Pass {} uses the same image twice", this->pass.name);
   }
 
   this->pass.uses.push_back({image, access});

engine/src/renderer/sprite_render_system.cpp

@@ -45,8 +45,9 @@ void SpriteRenderSystem::render(vk::CommandBuffer commandBuffer,
 
   u32 available = MAX_INSTANCES_PER_FRAME - this->instanceCursor;
   if (instances.size() > available) {
-    log::warning("SpriteRenderSystem: frame instance buffer full, dropping",
-                 instances.size() - available, "sprites");
+    log::warning(
+        "SpriteRenderSystem: frame instance buffer full, dropping {} sprites",
+        instances.size() - available);
   }
 
   Buffer& buffer = *this->instanceBuffers[this->frameIndex];

engine/src/resources/resource_registry_ref.cpp

@@ -26,7 +26,7 @@ TextureHandle ResourceRegistryRef::load<Texture>(const std::string& path) {
   // Always decode to RGBA8, whatever the file has.
   stbi_uc* pixels = stbi_load(path.c_str(), &width, &height, &channels, 4);
   if (pixels == nullptr) {
-    log::fatal("failed to load texture", path, "-", stbi_failure_reason());
+    log::fatal("failed to load texture {} - {}", path, stbi_failure_reason());
     throw std::runtime_error("failed to load texture: " + path);
   }
 

engine/src/vulkan/access.cpp

@@ -75,7 +75,7 @@ AccessState getStateForLayout(vk::ImageLayout layout) {
     }
   }
 
-  log::fatal("Unsupported image layout:", vk::to_string(layout));
+  log::fatal("Unsupported image layout: {}", vk::to_string(layout));
   throw std::runtime_error("Unsupported image layout.");
 }
 

engine/src/vulkan/buffer.cpp

@@ -27,8 +27,8 @@ Buffer::Buffer(Device& device, vk::DeviceSize instanceSize, u32 instanceCount,
       memoryPropertyFlags{memoryPropertyFlags} {
   alignmentSize = getAlignment(instanceSize, minOffsetAlignment);
   bufferSize = alignmentSize * instanceCount;
-  device.createBuffer(bufferSize, usageFlags, memoryPropertyFlags, buffer,
-                      allocation);
+  device.createBuffer(bufferSize, this->usageFlags, this->memoryPropertyFlags,
+                      this->buffer, this->allocation, this->info);
 }
 
 Buffer::~Buffer() {
@@ -36,17 +36,14 @@ Buffer::~Buffer() {
   vmaDestroyBuffer(this->device.getAllocator(), this->buffer, this->allocation);
 }
 
-// VMA always maps the whole allocation, so `size` only exists to keep the
-// interface; `offset` is applied to the returned pointer.
-vk::Result Buffer::map(vk::DeviceSize size, vk::DeviceSize offset) {
+vk::Result Buffer::map() {
   SOPHIA_ASSERT(buffer && allocation, "Called map on buffer before create");
-  (void)size;
 
   void* base = nullptr;
   vk::Result result = static_cast<vk::Result>(
       vmaMapMemory(this->device.getAllocator(), this->allocation, &base));
   if (result == vk::Result::eSuccess) {
-    this->mapped = static_cast<char*>(base) + offset;
+    this->mapped = base;
   }
   return result;
 }
@@ -65,6 +62,9 @@ void Buffer::writeToBuffer(void* data, vk::DeviceSize size,
   if (size == VK_WHOLE_SIZE) {
     memcpy(mapped, data, bufferSize);
   } else {
+    SOPHIA_ASSERT(offset + size <= bufferSize,
+                  "write of {} bytes at offset {} overflows buffer of {} bytes",
+                  size, offset, bufferSize);
     char* memOffset = (char*)mapped;
     memOffset += offset;
     memcpy(memOffset, data, size);

engine/src/vulkan/buffer.hpp

@@ -19,8 +19,7 @@ class Buffer {
          vk::DeviceSize minOffsetAlignment = 1);
   ~Buffer();
 
-  vk::Result map(vk::DeviceSize size = VK_WHOLE_SIZE,
-                 vk::DeviceSize offset = 0);
+  vk::Result map();
   void unmap();
 
   void writeToBuffer(void* data, vk::DeviceSize size = VK_WHOLE_SIZE,
@@ -37,17 +36,22 @@ class Buffer {
   vk::DescriptorBufferInfo descriptorInfoForIndex(int index);
   vk::Result invalidateIndex(int index);
 
-  vk::Buffer getBuffer() const { return buffer; }
-  void* getMappedMemory() const { return mapped; }
-  uint32_t getInstanceCount() const { return instanceCount; }
+  void* getMappedMemory() const { return this->mapped; }
+  vk::Buffer getBuffer() const { return this->buffer; }
+  const VmaAllocationInfo& getAllocationInfo() const { return this->info; }
+  u32 getInstanceCount() const { return instanceCount; }
   vk::DeviceSize getInstanceSize() const { return instanceSize; }
-  vk::DeviceSize getAlignmentSize() const { return instanceSize; }
+  vk::DeviceSize getAlignmentSize() const { return alignmentSize; }
   vk::BufferUsageFlags getUsageFlags() const { return usageFlags; }
   vk::MemoryPropertyFlags getMemoryPropertyFlags() const {
     return memoryPropertyFlags;
   }
   vk::DeviceSize getBufferSize() const { return bufferSize; }
 
+  vk::DeviceAddress getDeviceAddress() {
+    return this->device.get()->getBufferAddress(this->buffer);
+  }
+
  private:
   static vk::DeviceSize getAlignment(vk::DeviceSize instanceSize,
                                      vk::DeviceSize minOffsetAlignment);
@@ -56,9 +60,10 @@ class Buffer {
   void* mapped = nullptr;
   vk::Buffer buffer = VK_NULL_HANDLE;
   VmaAllocation allocation = VK_NULL_HANDLE;
+  VmaAllocationInfo info;
 
   vk::DeviceSize bufferSize;
-  uint32_t instanceCount;
+  u32 instanceCount;
   vk::DeviceSize instanceSize;
   vk::DeviceSize alignmentSize;
   vk::BufferUsageFlags usageFlags;

engine/src/vulkan/device.cpp

@@ -2,6 +2,7 @@
 
 #include <string.h>
 
+#include <iostream>
 #include <set>
 #include <sophia/util/logger.hpp>
 
@@ -19,16 +20,16 @@ debugCallback(vk::DebugUtilsMessageSeverityFlagBitsEXT m_severity,
   (void)pUser_data;
 
   if (m_severity == vk::DebugUtilsMessageSeverityFlagBitsEXT::eError) {
-    log::error(pCallback_data->pMessage);
+    log::error("{}", pCallback_data->pMessage);
     return VK_SUCCESS;
   } else if (m_severity == vk::DebugUtilsMessageSeverityFlagBitsEXT::eWarning) {
-    log::warning(pCallback_data->pMessage);
+    log::warning("{}", pCallback_data->pMessage);
   } else if (m_severity == vk::DebugUtilsMessageSeverityFlagBitsEXT::eInfo) {
-    log::info(pCallback_data->pMessage);
+    log::info("{}", pCallback_data->pMessage);
   } else if (m_severity == vk::DebugUtilsMessageSeverityFlagBitsEXT::eVerbose) {
-    log::verbose(pCallback_data->pMessage);
+    log::verbose("{}", pCallback_data->pMessage);
   } else {
-    log::info(pCallback_data->pMessage);
+    log::info("{}", pCallback_data->pMessage);
   }
 
   return VK_FALSE;
@@ -107,8 +108,8 @@ static void forEachRequiredFeature(DeviceFeatureChain& chain, Fn&& fn) {
 static bool checkDeviceFeatureSupport(const vk::PhysicalDevice& device) {
   vk::PhysicalDeviceProperties properties = device.getProperties();
   if (properties.apiVersion < SOPHIA_VULKAN_API_VERSION) {
-    log::verbose("Skipping ", properties.deviceName,
-                 ": Vulkan 1.3 not supported");
+    log::verbose("Skipping {}: Vulkan 1.3 not supported",
+                 properties.deviceName.data());
     return false;
   }
 
@@ -119,8 +120,8 @@ static bool checkDeviceFeatureSupport(const vk::PhysicalDevice& device) {
   bool allSupported = true;
   forEachRequiredFeature(supported, [&](vk::Bool32 has, const char* name) {
     if (!has) {
-      log::verbose("Skipping ", properties.deviceName,
-                   ": missing device feature ", name);
+      log::verbose("Skipping {}: missing device feature {}",
+                   properties.deviceName.data(), name);
       allSupported = false;
     }
   });
@@ -183,7 +184,8 @@ vk::Format Device::findSupportedFormat(
 
 void Device::createBuffer(vk::DeviceSize size, vk::BufferUsageFlags usage,
                           vk::MemoryPropertyFlags properties,
-                          vk::Buffer& buffer, VmaAllocation& allocation) {
+                          vk::Buffer& buffer, VmaAllocation& allocation,
+                          VmaAllocationInfo& info) {
   vk::BufferCreateInfo bufferInfo = {};
   bufferInfo.size = size;
   bufferInfo.usage = usage;
@@ -195,9 +197,9 @@ void Device::createBuffer(vk::DeviceSize size, vk::BufferUsageFlags usage,
   VkBuffer rawBuffer = VK_NULL_HANDLE;
   VkResult result = vmaCreateBuffer(
       this->allocator, &static_cast<const VkBufferCreateInfo&>(bufferInfo),
-      &allocInfo, &rawBuffer, &allocation, nullptr);
+      &allocInfo, &rawBuffer, &allocation, &info);
   if (result != VK_SUCCESS) {
-    log::fatal("failed to create buffer. Error: ",
+    log::fatal("failed to create buffer. Error: {}",
                vk::to_string(static_cast<vk::Result>(result)));
     throw std::runtime_error("failed to create buffer");
   }
@@ -220,7 +222,7 @@ vk::CommandBuffer Device::beginSingleTimeCommands() {
       throw vk::SystemError(result);
     }
   } catch (const vk::SystemError& error) {
-    log::error("failed to allocate single time commandBuffer. Error: ",
+    log::error("failed to allocate single time commandBuffer. Error: {}",
                error.what());
     throw std::runtime_error("failed to allocate single time commandBuffer");
   }
@@ -234,7 +236,7 @@ vk::CommandBuffer Device::beginSingleTimeCommands() {
       throw vk::SystemError(result);
     }
   } catch (const vk::SystemError& error) {
-    log::error("failed to begin single time commandBuffer. Error: ",
+    log::error("failed to begin single time commandBuffer. Error: {}",
                error.what());
     throw std::runtime_error("failed to begin single time commandBuffer");
   }
@@ -278,7 +280,7 @@ void Device::createImageWithInfo(const vk::ImageCreateInfo& imageInfo,
       this->allocator, &static_cast<const VkImageCreateInfo&>(imageInfo),
       &allocInfo, &rawImage, &allocation, nullptr);
   if (result != VK_SUCCESS) {
-    log::fatal("failed to create image. Error: ",
+    log::fatal("failed to create image. Error: {}",
                vk::to_string(static_cast<vk::Result>(result)));
     throw std::runtime_error("failed to create image");
   }
@@ -374,7 +376,7 @@ std::vector<const char*> Device::getRequiredExtensions() {
     throw std::exception();
   }
 
-  log::verbose("Number of available extensions: ", available_extension_count);
+  log::verbose("Number of available extensions: {}", available_extension_count);
 
   log::verbose("Available extensions:");
   for (const auto& e : available_extensions) {
@@ -482,7 +484,7 @@ void Device::pickPhysicalDevice() {
     log::fatal("Failed to find any physical devices.");
     throw std::exception();
   }
-  log::verbose("Physical Devices count: ", physicalDevices.size());
+  log::verbose("Physical Devices count: {}", physicalDevices.size());
 
   // Select first physical device that is suitable
   for (const auto& device : physicalDevices) {
@@ -498,7 +500,7 @@ void Device::pickPhysicalDevice() {
   }
 
   this->properties = this->physicalDevice.getProperties();
-  log::verbose("Physical Device: ", this->properties.deviceName);
+  log::verbose("Physical Device: {}", this->properties.deviceName.data());
 }
 
 void Device::createLogicalDevice() {

engine/src/vulkan/device.hpp

@@ -69,7 +69,7 @@ class Device {
 
   void createBuffer(vk::DeviceSize size, vk::BufferUsageFlags usage,
                     vk::MemoryPropertyFlags properties, vk::Buffer& buffer,
-                    VmaAllocation& allocation);
+                    VmaAllocation& allocation, VmaAllocationInfo& info);
 
   vk::CommandBuffer beginSingleTimeCommands();
 

engine/src/vulkan/image.cpp

@@ -226,11 +226,12 @@ std::unique_ptr<Image> Image::Builder::build() {
 
     vk::Buffer stagingBuffer;
     VmaAllocation stagingAllocation;
-    this->device.createBuffer(this->initialDataSize,
-                              vk::BufferUsageFlagBits::eTransferSrc,
-                              vk::MemoryPropertyFlagBits::eHostVisible |
-                                  vk::MemoryPropertyFlagBits::eHostCoherent,
-                              stagingBuffer, stagingAllocation);
+    VmaAllocationInfo stagingAllocationInfo;
+    this->device.createBuffer(
+        this->initialDataSize, vk::BufferUsageFlagBits::eTransferSrc,
+        vk::MemoryPropertyFlagBits::eHostVisible |
+            vk::MemoryPropertyFlagBits::eHostCoherent,
+        stagingBuffer, stagingAllocation, stagingAllocationInfo);
 
     void* mapped = nullptr;
     vmaMapMemory(allocator, stagingAllocation, &mapped);

engine/src/vulkan/shader.cpp

@@ -25,7 +25,7 @@ std::vector<char> readFile(const std::string& path) {
   std::ifstream file(path, std::ios::ate | std::ios::binary);
 
   if (!file.is_open()) {
-    log::error("failed to open shader: " + path);
+    log::error("failed to open shader: {}", path);
     throw std::runtime_error("failed to open: " + path);
   }
 
@@ -46,22 +46,23 @@ void Shader::compile(const std::string& path, ShaderStage shaderStage) {
 
   std::vector<char> source = readFile(path);
 
-  log::info("Compiling shader: " + path);
+  log::info("Compiling shader: {}", path);
 
   shaderc::Compiler compiler;
   shaderc::SpvCompilationResult result = compiler.CompileGlslToSpv(
       source.data(), source.size(), toShadercKind(shaderStage), path.c_str());
 
   if (result.GetCompilationStatus() != shaderc_compilation_status_success) {
-    log::fatal("failed to compile shader:", path, result.GetErrorMessage());
+    log::fatal("failed to compile shader: {}: {}", path,
+               result.GetErrorMessage());
     throw std::runtime_error("failed to compile shader: " + path + ": " +
                              result.GetErrorMessage());
   }
 
   this->spirv.assign(result.cbegin(), result.cend());
 
-  log::info("Successfully compiled shader: " + path + " (" +
-            std::to_string(this->spirv.size() * 4) + " bytes)");
+  log::info("Successfully compiled shader: {} ({} bytes)", path,
+            this->spirv.size() * 4);
 }
 
 void Shader::load(const std::string& path, ShaderStage shaderStage) {
@@ -70,15 +71,14 @@ void Shader::load(const std::string& path, ShaderStage shaderStage) {
   std::vector<char> bytes = readFile(path);
 
   if (bytes.size() % sizeof(u32) != 0) {
-    log::fatal("invalid SPIR-V binary (size not a multiple of 4):", path);
+    log::fatal("invalid SPIR-V binary (size not a multiple of 4): {}", path);
     throw std::runtime_error("invalid SPIR-V binary: " + path);
   }
 
   this->spirv.assign(reinterpret_cast<const u32*>(bytes.data()),
                      reinterpret_cast<const u32*>(bytes.data() + bytes.size()));
 
-  log::info("Loaded precompiled shader: " + path + " (" +
-            std::to_string(bytes.size()) + " bytes)");
+  log::info("Loaded precompiled shader: {} ({} bytes)", path, bytes.size());
 }
 
 Shader::Builder& Shader::Builder::fromGLSL(const std::string& path) {

engine/src/vulkan/swapchain.cpp

@@ -114,7 +114,7 @@ void Swapchain::createSwapchain() {
         this->device.get()->createSwapchainKHR(this->swapchainCreateInfo);
     // log::trace("created vk::SwapchainKHR");
   } catch (const vk::SystemError& err) {
-    log::fatal("failed to create swapchain. Error: ", err.what());
+    log::fatal("failed to create swapchain. Error: {}", err.what());
     throw std::runtime_error("failed to create swapchain");
   }
 }

engine/src/vulkan/vk_check.hpp

@@ -0,0 +1,20 @@
+#pragma once
+
+#include <cstdio>
+#include <cstdlib>
+#include <source_location>
+#include <vulkan/vulkan.hpp>
+
+inline void vk_check(vk::Result result, std::source_location loc =
+                                            std::source_location::current()) {
+  if (result != vk::Result::eSuccess) {
+    std::fprintf(stderr, "%s:%u: %s: %s\n", loc.file_name(), loc.line(),
+                 loc.function_name(), vk::to_string(result).c_str());
+    std::abort();
+  }
+}
+
+inline void vk_check(VkResult result, std::source_location loc =
+                                          std::source_location::current()) {
+  vk_check(static_cast<vk::Result>(result), loc);
+}

examples/conway_game_of_life/CMakeLists.txt

@@ -0,0 +1,3 @@
+add_executable(conway_game_of_life main.cpp)
+
+target_link_libraries(conway_game_of_life PRIVATE ${PROJECT_NAME})

examples/conway_game_of_life/comway_game_of_life.frag

@@ -0,0 +1,3 @@
+#version 450
+
+void main(){}

examples/conway_game_of_life/main.cpp

@@ -0,0 +1,13 @@
+#include <iostream>
+#include <sophia/application.hpp>
+
+class ConwayGameOfLife : public sophia::Application {
+ public:
+  ConwayGameOfLife()
+      : Application{{.width = 800, .height = 600, .name = "ConwayGameOfLife"}} {
+  }
+
+  void onCreate() override {}
+};
+
+SOPHIA_MAIN(ConwayGameOfLife)

sandbox/README.md

@@ -0,0 +1,15 @@
+# sandbox
+
+A playground for working out the implementation and architecture of new engine features. It can include the engine's internal backend headers (`engine/src`) as well as the public API, so you can use classes such as `Device`, `RenderContext`, `RenderGraph` and `SceneRenderer` directly.
+
+Prototype a feature here first. Once its design settles, move it into the engine and expose it through the public API, which [testbed](../testbed/README.md) exercises.
+
+Any `.cpp` file in this directory is compiled in automatically.
+
+## Running
+
+```sh
+dev sandbox [args...]
+```
+
+This builds the `debug` preset and runs `build/debug/bin/sandbox`. Shaders are loaded from `shaders/` (`SANDBOX_SHADER_DIR`).

sandbox/main.cpp

@@ -1,28 +1,221 @@
 #define GLFW_INCLUDE_VULKAN
 #include <GLFW/glfw3.h>
+#include <spirv_reflect.h>
 
-#include <algorithm>
-#include <array>
-#include <cmath>
 #include <cstdint>
-#include <cstdio>
 #include <cstdlib>
-#include <glm/mat4x4.hpp>
-#include <glm/vec4.hpp>
-#include <vector>
+#include <iostream>
+#include <sophia/components.hpp>
+#include <sophia/scene_registry.hpp>
+#include <sophia/scene_view.hpp>
+#include <tracy/Tracy.hpp>
+#include <vulkan/vulkan.hpp>
 
-#define VK_CHECK(expr)                                                     \
-  do {                                                                     \
-    vk::Result result_ = (expr);                                           \
-    if (result_ != vk::Result::eSuccess) {                                 \
-      std::fprintf(stderr, "%s:%d: %s -> %d\n", __FILE__, __LINE__, #expr, \
-                   result_);                                               \
-      std::abort();                                                        \
-    }                                                                      \
-  } while (0)
+#include "renderer/render_context.hpp"
+#include "renderer/render_graph.hpp"
+#include "renderer/scene_renderer.hpp"
+#include "resources/resource_registry.hpp"
+#include "vulkan/buffer.hpp"
+#include "vulkan/device.hpp"
+#include "vulkan/shader.hpp"
+#include "window.hpp"
+
+// local includes
+#include "material.hpp"
 
 constexpr uint32_t WIDTH = 1280;
 constexpr uint32_t HEIGHT = 720;
-constexpr const char* NAME = "";
+constexpr const char* NAME = "sandbox";
 
-int main() { return EXIT_SUCCESS; }
+void immediate_submit(sophia::Device& device,
+                      std::function<void(VkCommandBuffer cmd)>&& function) {
+  auto command = device.beginSingleTimeCommands();
+  function(command);
+  device.endSingleTimeCommands(command);
+}
+
+void triangle_test() {
+  sophia::Window window{WIDTH, HEIGHT, NAME};
+  sophia::Device device{&window};
+  sophia::RenderContext renderContext{window, device};
+  sophia::ResourceRegistry resourceRegistry{device,
+                                            renderContext.getImageFormat()};
+
+  sophia::SceneRegistry sceneRegistry;
+  sophia::SceneRenderer sceneRenderer{sceneRegistry, resourceRegistry, device,
+                                      renderContext.getImageFormat()};
+
+  sophia::SceneHandle sceneHandle = sceneRegistry.create();
+  sophia::Scene& scene = sceneRegistry.get(sceneHandle);
+  sophia::Entity camera = scene.createCamera();
+
+  // {
+  //   auto& transform = camera.getComponent<sophia::TransformComponent>();
+  //   transform.position.z += 60;
+  // }
+
+  sophia::SceneView view;
+  view.scene = sceneHandle;
+  view.clearColor = {0.01f, 0.01f, 0.02f, 1.0f};
+  view.camera = camera;
+
+  auto vertexShader = sophia::Shader::Builder()
+                          .fromGLSL(SANDBOX_SHADER_DIR "/triangle.vert")
+                          .setStage(sophia::ShaderStage::VERTEX)
+                          .build();
+  auto fragmentShader = sophia::Shader::Builder()
+                            .fromGLSL(SANDBOX_SHADER_DIR "/triangle.frag")
+                            .setStage(sophia::ShaderStage::FRAGMENT)
+                            .build();
+  vk::Format depthFormat = resourceRegistry.renderTargetPool.getDepthFormat();
+  sophia::Material material{device, std::move(vertexShader),
+                            std::move(fragmentShader),
+                            renderContext.getImageFormat(), depthFormat};
+
+  struct TriangleVertex {
+    sophia::vec4 vertex;
+    sophia::vec4 color;
+  };
+
+  TriangleVertex verticies[] = {
+      {{-1.f, 1.f, 0.0f, 0.0f}, {1.0f, 0.0f, 0.0f, 0.0f}},
+      {{1.f, 1.f, 0.0f, 0.0f}, {0.0f, 1.0f, 0.0f, 0.0f}},
+      {{0.f, -1.f, 0.0f, 0.0f}, {0.0f, 0.0f, 1.0f, 0.0f}}};
+  sophia::u32 triangleVerticiesCount = 3;
+
+  sophia::Buffer triangleBuffer{device, sizeof(TriangleVertex),
+                                triangleVerticiesCount,
+                                vk::BufferUsageFlagBits::eShaderDeviceAddress,
+                                vk::MemoryPropertyFlagBits::eHostVisible |
+                                    vk::MemoryPropertyFlagBits::eHostCoherent};
+  triangleBuffer.map();
+
+  triangleBuffer.writeToBuffer(verticies);
+
+  vk::DeviceAddress address = triangleBuffer.getDeviceAddress();
+
+  while (!window.shouldClose()) {
+    glfwPollEvents();
+
+    vk::CommandBuffer commandBuffer = renderContext.beginFrame();
+    if (!commandBuffer) {
+      continue;
+    }
+
+    sceneRenderer.beginFrame(renderContext.getFrameIndex());
+
+    sophia::RenderGraph graph{renderContext.getTracyContext()};
+    sophia::ImageRef color = graph.importImage(renderContext.getCurrentImage(),
+                                               sophia::Access::Present);
+    sophia::ImageRef depth = graph.importImage(
+        renderContext.getCurrentDepthImage(), sophia::Access::DepthWrite);
+
+    graph.addPass(
+        "sandbox",
+        [&](sophia::RenderGraph::PassBuilder& pass) {
+          const sophia::vec4& c = view.clearColor;
+          pass.writeColor(color, vk::AttachmentLoadOp::eClear,
+                          {c.r, c.g, c.b, c.a});
+          pass.writeDepth(depth, vk::AttachmentLoadOp::eClear);
+        },
+        [&](vk::CommandBuffer commandBuffer) {
+          ZoneScopedN("main sandbox pass");
+          material.bind(commandBuffer);
+          sophia::Material::PushConstants push;
+          push.data0 = address;
+
+          commandBuffer.pushConstants(
+              material.getLayout(), vk::ShaderStageFlagBits::eVertex, 0,
+              sizeof(sophia::Material::PushConstants), &push);
+          commandBuffer.draw(3, 1, 0, 0);
+        });
+
+    /*
+    graph.addPass(
+      "scene",
+      [&](sophia::RenderGraph::PassBuilder& pass) {
+        const sophia::vec4& c = view.clearColor;
+        pass.writeColor(color, vk::AttachmentLoadOp::eClear,
+        {c.r, c.g, c.b, c.a});
+        pass.writeDepth(depth, vk::AttachmentLoadOp::eClear);
+      },
+      [&](vk::CommandBuffer commandBuffer) {
+        ZoneScopedN("scene pass");
+        sceneRenderer.render(commandBuffer, view, view.camera,
+        renderContext.getExtent());
+      });
+      */
+
+    graph.execute(commandBuffer);
+
+    renderContext.endFrame();
+    FrameMark;
+  }
+
+  device.waitIdle();
+}
+
+int main() {
+  {
+    using namespace sophia;
+
+    auto shader = Shader::Builder()
+                      .fromGLSL(SANDBOX_SHADER_DIR "/shader.comp")
+                      .setStage(ShaderStage::VERTEX)
+                      .build();
+
+    std::vector<u32> spirv = shader.get()->getSpirv();
+    size_t spirv_size = spirv.size() * sizeof(u32);
+    void* spirv_code = spirv.data();
+
+    SpvReflectShaderModule module;
+    SpvReflectResult result =
+        spvReflectCreateShaderModule(spirv_size, spirv_code, &module);
+    assert(result == SPV_REFLECT_RESULT_SUCCESS);
+
+    {
+      log::print();
+      log::info("Reflecting Input Variables");
+
+      uint32_t count = 0;
+      result = spvReflectEnumerateInputVariables(&module, &count, NULL);
+      assert(result == SPV_REFLECT_RESULT_SUCCESS);
+      SpvReflectInterfaceVariable** vars =
+          (SpvReflectInterfaceVariable**)malloc(
+              count * sizeof(SpvReflectInterfaceVariable*));
+      result = spvReflectEnumerateInputVariables(&module, &count, vars);
+      assert(result == SPV_REFLECT_RESULT_SUCCESS);
+
+      for (size_t i = 0; i < count; i++) {
+        SpvReflectInterfaceVariable* var = vars[i];
+        assert(var != nullptr);
+
+        std::cout << "{" << std::endl;
+        log::print("\tname: {},", var->name);
+        std::cout << "}" << std::endl;
+        std::cout << std::endl;
+      }
+    }
+
+    {
+      log::print();
+      log::info("Reflecting Output Variables");
+
+      u32 count = 0;
+      result = spvReflectEnumerateOutputVariables(&module, &count, NULL);
+      assert(result == SPV_REFLECT_RESULT_SUCCESS);
+
+      SpvReflectInterfaceVariable** vars =
+          (SpvReflectInterfaceVariable**)malloc(
+              count * sizeof(SpvReflectInterfaceVariable*));
+
+      result = spvReflectEnumerateOutputVariables(&module, &count, vars);
+      assert(result == SPV_REFLECT_RESULT_SUCCESS);
+    }
+
+    spvReflectDestroyShaderModule(&module);
+  }
+
+  // triangle_test();
+  return EXIT_SUCCESS;
+}

sandbox/material.cpp

@@ -0,0 +1,45 @@
+#include "material.hpp"
+
+#include <sophia/util/logger.hpp>
+
+namespace sophia {
+
+Material::Material(Device& device, std::unique_ptr<Shader> vertexShader,
+                   std::unique_ptr<Shader> fragmentShader,
+                   vk::Format colorFormat, vk::Format depthFormat) {
+  createPipelineLayout(device);
+  this->pipeline = GraphicsPipeline::Builder(device)
+                       .setVertexShader(*vertexShader)
+                       .setFragmentShader(*fragmentShader)
+                       .setPipelineLayout(this->pipelineLayout.get())
+                       .setColorAttachmentFormats({colorFormat})
+                       .setDepthAttachmentFormat(depthFormat)
+                       .setDepthTest(true, true)
+                       .setCullMode(vk::CullModeFlagBits::eBack)
+                       .build();
+}
+
+Material::~Material() { log::trace("destroyed sophia::Material"); }
+
+void Material::createPipelineLayout(Device& device) {
+  vk::PushConstantRange pushConstantRange{};
+  pushConstantRange.stageFlags = vk::ShaderStageFlagBits::eVertex;
+  pushConstantRange.offset = 0;
+  pushConstantRange.size = sizeof(PushConstants);
+
+  vk::PipelineLayoutCreateInfo pipelineLayoutInfo = {};
+  pipelineLayoutInfo.setLayoutCount = 0;
+  pipelineLayoutInfo.pushConstantRangeCount = 1;
+  pipelineLayoutInfo.pPushConstantRanges = &pushConstantRange;
+
+  try {
+    this->pipelineLayout =
+        device.get()->createPipelineLayoutUnique(pipelineLayoutInfo);
+    log::trace("created vk::PipelineLayout");
+  } catch (const vk::SystemError& err) {
+    log::fatal("failed to create vk::PipelineLayout");
+    throw std::runtime_error("failed to create vk::PipelineLayout");
+  }
+}
+
+}  // namespace sophia

sandbox/material.hpp

@@ -0,0 +1,58 @@
+#pragma once
+
+#include <memory>
+#include <sophia/math.hpp>
+#include <vulkan/vulkan.hpp>
+
+#include "vulkan/device.hpp"
+#include "vulkan/pipelines/graphics_pipeline.hpp"
+#include "vulkan/shader.hpp"
+
+namespace sophia {
+
+class Material {
+ public:
+  struct PushConstants {
+    vk::DeviceAddress data0;
+    u64 padding;
+    vec4 data1;
+    vec4 data2;
+    vec4 data3;
+  };
+
+  Material(const Material&) = delete;
+  Material& operator=(const Material&) = delete;
+
+  Material(Device& device, std::unique_ptr<Shader> vertexShader,
+           std::unique_ptr<Shader> fragmentShader, vk::Format colorFormat,
+           vk::Format depthFormat);
+  ~Material();
+
+  void bind(vk::CommandBuffer commandBuffer) const {
+    pipeline->bind(commandBuffer);
+  }
+  vk::PipelineLayout getLayout() const { return pipelineLayout.get(); }
+
+ private:
+  void createPipelineLayout(Device& device);
+
+  vk::UniquePipelineLayout pipelineLayout;
+  std::unique_ptr<GraphicsPipeline> pipeline;
+};
+
+class MaterialInstance {
+ public:
+  void setBaseColor();
+
+ private:
+  Material* material;
+
+  vec3 base_color = {};
+};
+
+// !NOTE: eventually add ecs support for ecs
+// struct MaterialComponent {
+//   MaterialInstanceHandle handle;
+// };
+
+}  // namespace sophia

sandbox/renderer.cpp

@@ -0,0 +1,3 @@
+#include "renderer.hpp"
+
+namespace sophia {}  // namespace sophia

sandbox/renderer.hpp

@@ -0,0 +1,26 @@
+#pragma once
+
+#include <sophia/math.hpp>
+#include <vulkan/vulkan.hpp>
+
+#include "material.hpp"
+
+namespace sophia {
+
+struct RenderObject {
+  uint32_t indexCount;
+  uint32_t firstIndex;
+  vk::Buffer indexBuffer;
+
+  MaterialInstance* material;
+
+  mat4 transform;
+  VkDeviceAddress vertexBufferAddress;
+};
+
+class Renderer {
+ public:
+ private:
+};
+
+}  // namespace sophia

sandbox/shaders/shader.comp

@@ -0,0 +1,45 @@
+#version 450
+#extension GL_EXT_buffer_reference : require
+
+struct TriangleVertex {
+	vec4 vertex;
+	vec4 color;
+};
+
+layout(buffer_reference, std430) readonly buffer TriangleVertexBuffer {
+	TriangleVertex vertices[];
+};
+
+layout( push_constant ) uniform constants {
+	TriangleVertexBuffer triangleBuffer;
+	vec2 padding;
+	vec4 data1;
+	vec4 data2;
+	vec4 data3;
+} PushConstants;
+
+layout (location = 0) out vec3 outColor;
+
+void main()
+{
+	//const array of positions for the triangle
+	const vec3 positions[3] = vec3[3](
+		vec3(-1.f,1.f, 0.0f),
+		vec3(1.f,1.f, 0.0f),
+		vec3(0.f,-1.f, 0.0f)
+	);
+
+	//const array of colors for the triangle
+	const vec3 colors[3] = vec3[3](
+		vec3(1.0f, 0.0f, 0.0f), //red
+		vec3(0.0f, 1.0f, 0.0f), //green
+		vec3(00.f, 0.0f, 1.0f)  //blue
+	);
+
+	// Load vertex data from device address
+	TriangleVertex v = PushConstants.triangleBuffer.vertices[gl_VertexIndex];
+
+	// output the position of each vertex
+	gl_Position = vec4(v.vertex.xyz, 1.0);
+	outColor = vec3(v.color.xyz);
+}

sandbox/shaders/triangle.frag

@@ -0,0 +1,13 @@
+#version 450
+
+//shader input
+layout (location = 0) in vec3 inColor;
+
+//output write
+layout (location = 0) out vec4 outFragColor;
+
+void main()
+{
+	//return red
+	outFragColor = vec4(inColor,1.0f);
+}

sandbox/shaders/triangle.vert

@@ -0,0 +1,45 @@
+#version 450
+#extension GL_EXT_buffer_reference : require
+
+struct TriangleVertex {
+	vec4 vertex;
+	vec4 color;
+};
+
+layout(buffer_reference, std430) readonly buffer TriangleVertexBuffer {
+	TriangleVertex vertices[];
+};
+
+layout( push_constant ) uniform constants {
+	TriangleVertexBuffer triangleBuffer;
+	vec2 padding;
+	vec4 data1;
+	vec4 data2;
+	vec4 data3;
+} PushConstants;
+
+layout (location = 0) out vec3 outColor;
+
+void main()
+{
+	//const array of positions for the triangle
+	const vec3 positions[3] = vec3[3](
+		vec3(-1.f,1.f, 0.0f),
+		vec3(1.f,1.f, 0.0f),
+		vec3(0.f,-1.f, 0.0f)
+	);
+
+	//const array of colors for the triangle
+	const vec3 colors[3] = vec3[3](
+		vec3(1.0f, 0.0f, 0.0f), //red
+		vec3(0.0f, 1.0f, 0.0f), //green
+		vec3(00.f, 0.0f, 1.0f)  //blue
+	);
+
+	// Load vertex data from device address
+	TriangleVertex v = PushConstants.triangleBuffer.vertices[gl_VertexIndex];
+
+	// output the position of each vertex
+	gl_Position = vec4(v.vertex.xyz, 1.0);
+	outColor = vec3(v.color.xyz);
+}

sandbox/shaders/vkguide_gradient.comp

@@ -0,0 +1,27 @@
+#version 460
+
+//size of a workgroup for compute
+layout (local_size_x = 16, local_size_y = 16) in;
+
+//descriptor bindings for the pipeline
+layout(rgba16f,set = 0, binding = 0) uniform image2D image;
+
+
+void main()
+{
+  ivec2 texelCoord = ivec2(gl_GlobalInvocationID.xy);
+	ivec2 size = imageSize(image);
+
+    if(texelCoord.x < size.x && texelCoord.y < size.y)
+    {
+        vec4 color = vec4(0.0, 0.0, 0.0, 1.0);
+
+        if(gl_LocalInvocationID.x != 0 && gl_LocalInvocationID.y != 0)
+        {
+            color.x = float(texelCoord.x)/(size.x);
+            color.y = float(texelCoord.y)/(size.y);
+        }
+
+        imageStore(image, texelCoord, color);
+    }
+}

testbed/CMakeLists.txt

@@ -9,7 +9,7 @@ target_link_libraries(${NAME}_deps INTERFACE
   ${ENGINE_NAME}
 )
 
-target_compile_features(${PROJECT_NAME} PUBLIC cxx_std_17)
+target_compile_features(${PROJECT_NAME} PUBLIC cxx_std_23)
 set_property(TARGET ${PROJECT_NAME} PROPERTY VS_DEBUGGER_WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}/build")
 
 add_executable(testbed main.cpp)

testbed/README.md

@@ -0,0 +1,13 @@
+# testbed
+
+Exercises the engine's frontend API. It includes only the public headers in `engine/include/sophia/`, so it uses the engine the way a game would.
+
+Use it to check that public API changes work and feel right from the caller's side. It cannot include engine internals (`engine/src`). If something needs them, it belongs in [sandbox](../sandbox/README.md) instead.
+
+## Running
+
+```sh
+dev testbed [args...]
+```
+
+This builds the `debug` preset and runs `build/debug/bin/testbed`. Shaders are loaded from `shaders/` (`TESTBED_SHADER_DIR`).