Thread RenderDevice through CommandBuffer; drop window param from swapchain methods

CommandBuffer now holds a weak reference to its RenderDevice instead of
a raw SDL_GPUDevice pointer. This gives it access to both device and window
without callers having to pass SDL_Window everywhere.

- acquireSwapchainTexture(self, &sc) — window implicit
- waitAndAcquireSwapchainTexture(self, &sc) — window implicit
- initWithCommandBuffer now takes (self, device, cmd)
- beginCopyPass uses self->device->device for SDL_GPUDevice

Hello.c refactored: Scene struct + drawScene(), Vertex type with named fields,
offsetof for vertex attribute offsets.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: jdolan

Examples/Hello-iOS/Hello-iOS.c

@@ -69,9 +69,9 @@ static const char *fragment_shader_msl =
 typedef struct {
 	float x, y, z;
 	float r, g, b;
-} VertexData;
+} Vertex;
 
-static const VertexData vertex_data[] = {
+static const Vertex vertex_data[] = {
 	{ -0.5f,  0.5f, -0.5f,  1, 0, 0 }, {  0.5f, -0.5f, -0.5f, 0, 0, 1 }, { -0.5f, -0.5f, -0.5f, 0, 1, 0 },
 	{ -0.5f,  0.5f, -0.5f,  1, 0, 0 }, {  0.5f,  0.5f, -0.5f, 1, 1, 0 }, {  0.5f, -0.5f, -0.5f, 0, 0, 1 },
 	{ -0.5f,  0.5f,  0.5f,  1, 1, 1 }, { -0.5f, -0.5f, -0.5f, 0, 1, 0 }, { -0.5f, -0.5f,  0.5f, 0, 1, 1 },
@@ -218,7 +218,7 @@ SDL_AppResult SDL_AppInit(void **unused, int argc, char *argv[]) {
 	};
 	SDL_GPUVertexBufferDescription vbDesc = {
 		.slot = 0,
-		.pitch = sizeof(VertexData),
+		.pitch = sizeof(Vertex),
 		.input_rate = SDL_GPU_VERTEXINPUTRATE_VERTEX,
 	};
 	SDL_GPUVertexAttribute vertexAttribs[] = {

Examples/Hello.c

@@ -31,11 +31,18 @@
 #endif
 
 typedef struct {
-	float x, y, z;
-	float r, g, b;
-} VertexData;
+  RenderDevice *renderDevice;
+  Framebuffer *framebuffer;
+  SDL_GPUGraphicsPipeline *pipeline;
+  SDL_GPUBuffer *vertexBuffer;
+} Scene;
 
-static const VertexData vertex_data[] = {
+typedef struct {
+	float3 position;
+	float3 color;
+} Vertex;
+
+static const Vertex vertexes[] = {
 	{ -0.5f,  0.5f, -0.5f,  1, 0, 0 }, {  0.5f, -0.5f, -0.5f, 0, 0, 1 }, { -0.5f, -0.5f, -0.5f, 0, 1, 0 },
 	{ -0.5f,  0.5f, -0.5f,  1, 0, 0 }, {  0.5f,  0.5f, -0.5f, 1, 1, 0 }, {  0.5f, -0.5f, -0.5f, 0, 0, 1 },
 	{ -0.5f,  0.5f,  0.5f,  1, 1, 1 }, { -0.5f, -0.5f, -0.5f, 0, 1, 0 }, { -0.5f, -0.5f,  0.5f, 0, 1, 1 },
@@ -50,26 +57,77 @@ static const VertexData vertex_data[] = {
 	{ -0.5f, -0.5f, -0.5f,  0, 1, 0 }, {  0.5f, -0.5f, -0.5f, 0, 0, 1 }, {  0.5f, -0.5f,  0.5f, 1, 0, 1 },
 };
 
+/**
+ * @brief
+ */
+static void drawScene(Scene *scene) {
+  static float2 angles;
+  static Uint64 lastTicks;
+
+  Uint64 ticks = SDL_GetTicks();
+  float dt = (float) (ticks - lastTicks) / 1000.0f;
+  lastTicks = ticks;
+
+  angles.x += dt * 30.0f;
+  angles.y += dt * 60.0f;
+
+  while (angles.x >= 360.0f) {
+    angles.x -= 360.0f;
+  }
+  while (angles.y >= 360.0f) {
+    angles.y -= 360.0f;
+  }
+
+  CommandBuffer *cmd = $(scene->renderDevice, acquireCommandBuffer);
+
+  SwapchainTexture swapchain = { 0 };
+  $(cmd, waitAndAcquireSwapchainTexture, &swapchain);
+
+  float4x4 modelView = float4x4_rotation(angles.x, float3_new(1.f, 0.f, 0.f));
+  modelView = float4x4_mul(float4x4_rotation(angles.y, float3_new(0.f, 1.f, 0.f)), modelView);
+  modelView = float4x4_mul(float4x4_translation(float3_new(0.f, 0.f, -2.5f)), modelView);
+  const float4x4 projection = float4x4_perspective(45.f, (float) swapchain.size.w / (float) swapchain.size.h, 0.01f, 100.f);
+  const float4x4 modelViewProjection = float4x4_mul(projection, modelView);
+
+  SDL_GPUColorTargetInfo colorTarget = {
+    .texture = swapchain.texture,
+    .clear_color = { 0.1f, 0.1f, 0.2f, 1.0f },
+    .load_op = SDL_GPU_LOADOP_CLEAR,
+    .store_op = SDL_GPU_STOREOP_STORE,
+  };
+
+  SDL_GPUDepthStencilTargetInfo depthTarget = $(scene->framebuffer, depthTargetInfo, SDL_GPU_LOADOP_CLEAR, SDL_GPU_STOREOP_DONT_CARE, 1.f);
+
+  RenderPass *renderPass = $(cmd, beginRenderPass, &colorTarget, 1, &depthTarget);
+  $(renderPass, bindPipeline, scene->pipeline);
+  $(renderPass, bindVertexBuffers, 0, &(SDL_GPUBufferBinding) {
+    .buffer = scene->vertexBuffer,
+    .offset = 0,
+  }, 1);
+  $(cmd, pushVertexUniformData, 0, modelViewProjection.f, sizeof(modelViewProjection));
+  $(renderPass, drawPrimitives, (Uint32) SDL_arraysize(vertexes), 1, 0, 0);
+  release(renderPass);
+
+  $(cmd, submit);
+  release(cmd);
+}
+
 /**
  * @brief
  */
 int main(int argc, char **argv) {
 
+  $$(Resource, addResourcePath, EXAMPLES);
+
   GPU_Assert(SDL_Init(SDL_INIT_VIDEO), "SDL_Init");
 
 	SDL_Window *window = SDL_CreateWindow("ObjectivelyGPU Hello", 800, 600, SDL_WINDOW_HIGH_PIXEL_DENSITY);
   GPU_Assert(window, "SDL_CreateWindow");
 
-  $$(Resource, addResourcePath, EXAMPLES);
-
   RenderDevice *renderDevice = $(alloc(RenderDevice), initWithWindow, window);
   GPU_Assert(renderDevice, "RenderDevice init");
 
-	SDL_GPUBuffer *vertexBuffer = $(renderDevice, createBufferWithConstMem,
-		SDL_GPU_BUFFERUSAGE_VERTEX, vertex_data, sizeof(vertex_data));
-
-	int w = 0;
-	int h = 0;
+	int w, h;
   SDL_GetWindowSizeInPixels(window, &w, &h);
 
   Framebuffer *framebuffer = $(alloc(Framebuffer), initWithDevice, renderDevice,
@@ -94,7 +152,7 @@ int main(int argc, char **argv) {
 
   SDL_GPUVertexBufferDescription vertexBufferDescription = {
 		.slot = 0,
-		.pitch = sizeof(VertexData),
+		.pitch = sizeof(Vertex),
 		.input_rate = SDL_GPU_VERTEXINPUTRATE_VERTEX,
 		.instance_step_rate = 0,
 	};
@@ -104,13 +162,13 @@ int main(int argc, char **argv) {
 			.location = 0,
 			.buffer_slot = 0,
 			.format = SDL_GPU_VERTEXELEMENTFORMAT_FLOAT3,
-			.offset = 0,
+			.offset = offsetof(Vertex, position),
 		},
 		{
 			.location = 1,
 			.buffer_slot = 0,
 			.format = SDL_GPU_VERTEXELEMENTFORMAT_FLOAT3,
-			.offset = 12,
+			.offset = offsetof(Vertex, color),
 		},
 	};
 
@@ -149,11 +207,9 @@ int main(int argc, char **argv) {
 	$(renderDevice, releaseShader, vertexShader);
 	$(renderDevice, releaseShader, fragmentShader);
 
-	bool running = true;
-	float angleX = 0.0f;
-	float angleY = 0.0f;
-	Uint64 lastTicks = SDL_GetTicks();
+  SDL_GPUBuffer *vertexBuffer = $(renderDevice, createBufferWithConstMem, SDL_GPU_BUFFERUSAGE_VERTEX, vertexes, sizeof(vertexes));
 
+	bool running = true;
 	while (running) {
 		SDL_Event event;
 		while (SDL_PollEvent(&event)) {
@@ -167,52 +223,12 @@ int main(int argc, char **argv) {
 			}
 		}
 
-		Uint64 ticks = SDL_GetTicks();
-		float dt = (float) (ticks - lastTicks) / 1000.0f;
-		lastTicks = ticks;
-
-		angleX += dt * 30.0f;
-		angleY += dt * 60.0f;
-
-		while (angleX >= 360.0f) {
-			angleX -= 360.0f;
-		}
-		while (angleY >= 360.0f) {
-			angleY -= 360.0f;
-		}
-
-		CommandBuffer *cmd = $(renderDevice, acquireCommandBuffer);
-
-		SwapchainTexture swapchain = { 0 };
-		$(cmd, waitAndAcquireSwapchainTexture, window, &swapchain);
-
-		float4x4 modelView = float4x4_rotation(angleX, float3_new(1.f, 0.f, 0.f));
-		modelView = float4x4_mul(float4x4_rotation(angleY, float3_new(0.f, 1.f, 0.f)), modelView);
-		modelView = float4x4_mul(float4x4_translation(float3_new(0.f, 0.f, -2.5f)), modelView);
-		const float4x4 projection = float4x4_perspective(45.f, (float) swapchain.size.w / (float) swapchain.size.h, 0.01f, 100.f);
-		const float4x4 modelViewProjection = float4x4_mul(projection, modelView);
-
-		SDL_GPUColorTargetInfo colorTarget = {
-			.texture = swapchain.texture,
-			.clear_color = { 0.1f, 0.1f, 0.2f, 1.0f },
-			.load_op = SDL_GPU_LOADOP_CLEAR,
-			.store_op = SDL_GPU_STOREOP_STORE,
-		};
-
-		SDL_GPUDepthStencilTargetInfo depthTarget = $(framebuffer, depthTargetInfo, SDL_GPU_LOADOP_CLEAR, SDL_GPU_STOREOP_DONT_CARE, 1.f);
-
-		RenderPass *renderPass = $(cmd, beginRenderPass, &colorTarget, 1, &depthTarget);
-		$(renderPass, bindPipeline, pipeline);
-		$(renderPass, bindVertexBuffers, 0, &(SDL_GPUBufferBinding) {
-			.buffer = vertexBuffer,
-			.offset = 0,
-		}, 1);
-		$(cmd, pushVertexUniformData, 0, modelViewProjection.f, sizeof(modelViewProjection));
-		$(renderPass, drawPrimitives, (Uint32) SDL_arraysize(vertex_data), 1, 0, 0);
-		release(renderPass);
-
-		$(cmd, submit);
-		release(cmd);
+    drawScene(&(Scene) {
+      .renderDevice = renderDevice,
+      .framebuffer = framebuffer,
+      .pipeline = pipeline,
+      .vertexBuffer = vertexBuffer
+    });
 	}
 
 	$(renderDevice, waitForIdle);

Examples/HelloCompute.c

@@ -144,7 +144,7 @@ int main(int argc, char **argv) {
 
 		CommandBuffer *cmd = $(renderDevice, acquireCommandBuffer);
 		SwapchainTexture swapchain = { 0 };
-		$(cmd, waitAndAcquireSwapchainTexture, window, &swapchain);
+		$(cmd, waitAndAcquireSwapchainTexture, &swapchain);
 
 		float time = (float) (SDL_GetTicks() - startTicks) / 1000.0f;
 		$(cmd, pushComputeUniformData, 0, &time, sizeof(time));

Sources/ObjectivelyGPU/CommandBuffer.c

@@ -26,22 +26,23 @@
 #include "CommandBuffer.h"
 #include "ComputePass.h"
 #include "CopyPass.h"
+#include "RenderDevice.h"
 #include "RenderPass.h"
 
 #define _Class _CommandBuffer
 
 #pragma mark - CommandBuffer
 
 /**
- * @fn bool CommandBuffer::acquireSwapchainTexture(const CommandBuffer *self, SDL_Window *window, SwapchainTexture *swapchain)
+ * @fn bool CommandBuffer::acquireSwapchainTexture(const CommandBuffer *self, SwapchainTexture *swapchain)
  * @memberof CommandBuffer
  */
-static bool acquireSwapchainTexture(const CommandBuffer *self, SDL_Window *window, SwapchainTexture *swapchain) {
+static bool acquireSwapchainTexture(const CommandBuffer *self, SwapchainTexture *swapchain) {
 
   assert(swapchain);
 
   return SDL_AcquireGPUSwapchainTexture(self->cmd,
-                                        window,
+                                        self->device->window,
                                         &swapchain->texture,
                                         (Uint32 *) &swapchain->size.w,
                                         (Uint32 *) &swapchain->size.h);
@@ -68,7 +69,7 @@ static CopyPass *beginCopyPass(const CommandBuffer *self) {
   SDL_GPUCopyPass *pass = SDL_BeginGPUCopyPass(self->cmd);
   GPU_Assert(pass, "SDL_BeginGPUCopyPass");
 
-  return $(alloc(CopyPass), init, pass, self->device);
+  return $(alloc(CopyPass), init, pass, self->device->device);
 }
 
 /**
@@ -114,13 +115,15 @@ static void generateMipmaps(const CommandBuffer *self, SDL_GPUTexture *texture)
 }
 
 /**
- * @fn CommandBuffer *CommandBuffer::initWithCommandBuffer(CommandBuffer *self, SDL_GPUCommandBuffer *cmd)
+ * @fn CommandBuffer *CommandBuffer::initWithCommandBuffer(CommandBuffer *self, const RenderDevice *device, SDL_GPUCommandBuffer *cmd)
  * @memberof CommandBuffer
  */
-static CommandBuffer *initWithCommandBuffer(CommandBuffer *self, SDL_GPUCommandBuffer *cmd) {
+static CommandBuffer *initWithCommandBuffer(CommandBuffer *self, const RenderDevice *device, SDL_GPUCommandBuffer *cmd) {
 
   self = (CommandBuffer *) super(Object, self, init);
   if (self) {
+    assert(device);
+    self->device = (RenderDevice *) device;
     self->cmd = cmd;
     assert(self->cmd);
   }
@@ -201,15 +204,15 @@ static SDL_GPUFence *submitAndFence(const CommandBuffer *self) {
 }
 
 /**
- * @fn bool CommandBuffer::waitAndAcquireSwapchainTexture(const CommandBuffer *self, SDL_Window *window, SwapchainTexture *swapchain)
+ * @fn bool CommandBuffer::waitAndAcquireSwapchainTexture(const CommandBuffer *self, SwapchainTexture *swapchain)
  * @memberof CommandBuffer
  */
-static bool waitAndAcquireSwapchainTexture(const CommandBuffer *self, SDL_Window *window, SwapchainTexture *swapchain) {
+static bool waitAndAcquireSwapchainTexture(const CommandBuffer *self, SwapchainTexture *swapchain) {
 
   assert(swapchain);
 
   return SDL_WaitAndAcquireGPUSwapchainTexture(self->cmd,
-                                               window,
+                                               self->device->window,
                                                &swapchain->texture,
                                                (Uint32 *) &swapchain->size.w,
                                                (Uint32 *) &swapchain->size.h);

Sources/ObjectivelyGPU/CommandBuffer.h

@@ -35,6 +35,7 @@
 typedef struct ComputePass ComputePass;
 typedef struct CopyPass CopyPass;
 typedef struct RenderPass RenderPass;
+typedef struct RenderDevice RenderDevice;
 typedef struct CommandBuffer CommandBuffer;
 typedef struct CommandBufferInterface CommandBufferInterface;
 typedef struct SwapchainTexture SwapchainTexture;
@@ -89,10 +90,9 @@ struct CommandBuffer {
   SDL_GPUCommandBuffer *cmd;
 
   /**
-   * @brief The GPU device, threaded through to pass objects that need it.
-   * @private
+   * @brief The RenderDevice that this CommandBuffer belongs to.
    */
-  SDL_GPUDevice *device;
+  RenderDevice *device;
 };
 
 /**
@@ -106,18 +106,17 @@ struct CommandBufferInterface {
   ObjectInterface objectInterface;
 
   /**
-   * @fn bool CommandBuffer::acquireSwapchainTexture(const CommandBuffer *self, SDL_Window *window, SwapchainTexture *swapchain)
+   * @fn bool CommandBuffer::acquireSwapchainTexture(const CommandBuffer *self, SwapchainTexture *swapchain)
    * @brief Acquires the next swapchain texture for rendering.
    * @details Returns `false` (without asserting) when the window is minimised
    *   or the swapchain is temporarily unavailable. The caller should skip
    *   rendering for that frame.
    * @param self The CommandBuffer.
-   * @param window The window whose swapchain to acquire.
    * @param swapchain Output structure populated with the texture and dimensions.
    * @return True on success, false when the swapchain is unavailable this frame.
    * @memberof CommandBuffer
    */
-  bool (*acquireSwapchainTexture)(const CommandBuffer *self, SDL_Window *window, SwapchainTexture *swapchain);
+  bool (*acquireSwapchainTexture)(const CommandBuffer *self, SwapchainTexture *swapchain);
 
   /**
    * @fn ComputePass *CommandBuffer::beginComputePass(const CommandBuffer *self, ...)
@@ -185,14 +184,15 @@ struct CommandBufferInterface {
   void (*generateMipmaps)(const CommandBuffer *self, SDL_GPUTexture *texture);
 
   /**
-   * @fn CommandBuffer *CommandBuffer::initWithCommandBuffer(CommandBuffer *self, SDL_GPUCommandBuffer *cmd)
+   * @fn CommandBuffer *CommandBuffer::initWithCommandBuffer(CommandBuffer *self, const RenderDevice *device, *SDL_GPUCommandBuffer *cmd)
    * @brief Initializes this CommandBuffer wrapping the given SDL command buffer.
    * @param self The CommandBuffer.
+   * @param device The RenderDevice that created this CommandBuffer.
    * @param cmd The SDL command buffer to wrap. Must not be NULL.
    * @return The initialized CommandBuffer, or NULL on failure.
    * @memberof CommandBuffer
    */
-  CommandBuffer *(*initWithCommandBuffer)(CommandBuffer *self, SDL_GPUCommandBuffer *cmd);
+  CommandBuffer *(*initWithCommandBuffer)(CommandBuffer *self, const RenderDevice *device, SDL_GPUCommandBuffer *cmd);
 
   /**
    * @fn void CommandBuffer::insertDebugLabel(const CommandBuffer *self, const char *text)
@@ -259,17 +259,16 @@ struct CommandBufferInterface {
   SDL_GPUFence *(*submitAndFence)(const CommandBuffer *self);
 
   /**
-   * @fn bool CommandBuffer::waitAndAcquireSwapchainTexture(const CommandBuffer *self, SDL_Window *window, SwapchainTexture *swapchain)
+   * @fn bool CommandBuffer::waitAndAcquireSwapchainTexture(const CommandBuffer *self, SwapchainTexture *swapchain)
    * @brief Blocks until a swapchain texture is available, then acquires it.
    * @details Prefer `acquireSwapchainTexture` unless you must guarantee a
    *   texture this frame (e.g. during resize).
    * @param self The CommandBuffer.
-   * @param window The window whose swapchain to acquire.
    * @param swapchain Output structure populated with the texture and dimensions.
    * @return True on success, false on error.
    * @memberof CommandBuffer
    */
-  bool (*waitAndAcquireSwapchainTexture)(const CommandBuffer *self, SDL_Window *window, SwapchainTexture *swapchain);
+  bool (*waitAndAcquireSwapchainTexture)(const CommandBuffer *self, SwapchainTexture *swapchain);
 };
 
 /**

Sources/ObjectivelyGPU/RenderDevice.c

@@ -73,9 +73,7 @@ static CommandBuffer *acquireCommandBuffer(const RenderDevice *self) {
   SDL_GPUCommandBuffer *cmd = SDL_AcquireGPUCommandBuffer(self->device);
   GPU_Assert(cmd, "SDL_AcquireGPUCommandBuffer");
 
-  CommandBuffer *buffer = $(alloc(CommandBuffer), initWithCommandBuffer, cmd);
-  buffer->device = self->device;
-  return buffer;
+  return $(alloc(CommandBuffer), initWithCommandBuffer, self, cmd);
 }
 
 /**