Reorder pass init params: (self, cmd, pass) for RenderPass and ComputePass

CommandBuffer is the owning object and takes precedence over the wrapped
SDL pass. Matches CopyPass convention. Updated @fn docs, @param order,
struct member order, and all call sites.

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

Author: jdolan

Sources/ObjectivelyGPU/CommandBuffer.c

@@ -57,7 +57,7 @@ static ComputePass *beginComputePass(const CommandBuffer *self, const SDL_GPUSto
   SDL_GPUComputePass *pass = SDL_BeginGPUComputePass(self->cmd, storageTextures, numStorageTextures, storageBuffers, numStorageBuffers);
   GPU_Assert(pass, "SDL_BeginGPUComputePass");
 
-  return $(alloc(ComputePass), init, pass, (CommandBuffer *) self);
+  return $(alloc(ComputePass), init, (CommandBuffer *) self, pass);
 }
 
 /**
@@ -69,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, (CommandBuffer *) self);
+  return $(alloc(CopyPass), init, (CommandBuffer *) self, pass);
 }
 
 /**
@@ -81,7 +81,7 @@ static RenderPass *beginRenderPass(const CommandBuffer *self, const SDL_GPUColor
   SDL_GPURenderPass *pass = SDL_BeginGPURenderPass(self->cmd, colorTargets, numColorTargets, depthStencil);
   GPU_Assert(pass, "SDL_BeginGPURenderPass");
 
-  return $(alloc(RenderPass), init, pass, (CommandBuffer *) self);
+  return $(alloc(RenderPass), init, (CommandBuffer *) self, pass);
 }
 
 /**

Sources/ObjectivelyGPU/ComputePass.c

@@ -94,17 +94,17 @@ static void dispatchComputeIndirect(const ComputePass *self, SDL_GPUBuffer *buff
 }
 
 /**
- * @fn ComputePass *ComputePass::init(ComputePass *self, SDL_GPUComputePass *pass, CommandBuffer *cmd)
+ * @fn ComputePass *ComputePass::init(ComputePass *self, CommandBuffer *cmd, SDL_GPUComputePass *pass)
  * @memberof ComputePass
  */
-static ComputePass *init(ComputePass *self, SDL_GPUComputePass *pass, CommandBuffer *cmd) {
+static ComputePass *init(ComputePass *self, CommandBuffer *cmd, SDL_GPUComputePass *pass) {
 
   self = (ComputePass *) super(Object, self, init);
   if (self) {
-    self->pass = pass;
-    assert(self->pass);
     self->cmd = cmd;
     assert(self->cmd);
+    self->pass = pass;
+    assert(self->pass);
   }
 
   return self;

Sources/ObjectivelyGPU/ComputePass.h

@@ -136,15 +136,15 @@ struct ComputePassInterface {
   void (*dispatchComputeIndirect)(const ComputePass *self, SDL_GPUBuffer *buffer, Uint32 offset);
 
   /**
-   * @fn ComputePass *ComputePass::init(ComputePass *self, SDL_GPUComputePass *pass, CommandBuffer *cmd)
+   * @fn ComputePass *ComputePass::init(ComputePass *self, CommandBuffer *cmd, SDL_GPUComputePass *pass)
    * @brief Initializes this ComputePass wrapping the given SDL compute pass.
    * @param self The ComputePass.
-   * @param pass The SDL compute pass to wrap. Must not be NULL.
    * @param cmd The CommandBuffer this pass was begun from.
+   * @param pass The SDL compute pass to wrap. Must not be NULL.
    * @return The initialized ComputePass, or NULL on failure.
    * @memberof ComputePass
    */
-  ComputePass *(*init)(ComputePass *self, SDL_GPUComputePass *pass, CommandBuffer *cmd);
+  ComputePass *(*init)(ComputePass *self, CommandBuffer *cmd, SDL_GPUComputePass *pass);
 };
 
 /**

Sources/ObjectivelyGPU/CopyPass.c

@@ -80,17 +80,17 @@ static void downloadTexture(const CopyPass *self, const SDL_GPUTextureRegion *sr
 }
 
 /**
- * @fn CopyPass *CopyPass::init(CopyPass *self, SDL_GPUCopyPass *pass, CommandBuffer *cmd)
+ * @fn CopyPass *CopyPass::init(CopyPass *self, CommandBuffer *cmd, SDL_GPUCopyPass *pass)
  * @memberof CopyPass
  */
-static CopyPass *init(CopyPass *self, SDL_GPUCopyPass *pass, CommandBuffer *cmd) {
+static CopyPass *init(CopyPass *self, CommandBuffer *cmd, SDL_GPUCopyPass *pass) {
 
   self = (CopyPass *) super(Object, self, init);
   if (self) {
-    self->pass = pass;
-    assert(self->pass);
     self->cmd = cmd;
     assert(self->cmd);
+    self->pass = pass;
+    assert(self->pass);
   }
 
   return self;

Sources/ObjectivelyGPU/CopyPass.h

@@ -65,17 +65,17 @@ struct CopyPass {
   CopyPassInterface *interface;
 
   /**
-   * @brief The underlying SDL copy pass.
-   * @details Set to NULL by `dealloc` after `SDL_EndGPUCopyPass` is called.
+   * @brief The CommandBuffer this pass was begun from.
    * @private
    */
-  SDL_GPUCopyPass *pass;
+  CommandBuffer *cmd;
 
   /**
-   * @brief The CommandBuffer this pass was begun from.
+   * @brief The underlying SDL copy pass.
+   * @details Set to NULL by `dealloc` after `SDL_EndGPUCopyPass` is called.
    * @private
    */
-  CommandBuffer *cmd;
+  SDL_GPUCopyPass *pass;
 };
 
 /**
@@ -117,15 +117,15 @@ struct CopyPassInterface {
   void (*downloadTexture)(const CopyPass *self, const SDL_GPUTextureRegion *src, const SDL_GPUTextureTransferInfo *dst);
 
   /**
-   * @fn CopyPass *CopyPass::init(CopyPass *self, SDL_GPUCopyPass *pass, CommandBuffer *cmd)
+   * @fn CopyPass *CopyPass::init(CopyPass *self, CommandBuffer *cmd, SDL_GPUCopyPass *pass)
    * @brief Initializes this CopyPass wrapping the given SDL copy pass.
    * @param self The CopyPass.
+   * @param cmd The CommandBuffer that created this pass.
    * @param pass The SDL copy pass to wrap. Must not be NULL.
-   * @param cmd The CommandBuffer this pass was begun from.
    * @return The initialized CopyPass, or NULL on failure.
    * @memberof CopyPass
    */
-  CopyPass *(*init)(CopyPass *self, SDL_GPUCopyPass *pass, CommandBuffer *cmd);
+  CopyPass *(*init)(CopyPass *self, CommandBuffer *cmd, SDL_GPUCopyPass *pass);
 
   /**
    * @fn void CopyPass::uploadBuffer(const CopyPass *self, const SDL_GPUTransferBufferLocation *src, const SDL_GPUBufferRegion *dst, bool cycle)

Sources/ObjectivelyGPU/RenderPass.c

@@ -151,17 +151,17 @@ static void drawPrimitivesIndirect(const RenderPass *self, SDL_GPUBuffer *buffer
 }
 
 /**
- * @fn RenderPass *RenderPass::init(RenderPass *self, SDL_GPURenderPass *pass, CommandBuffer *cmd)
+ * @fn RenderPass *RenderPass::init(RenderPass *self, CommandBuffer *cmd, SDL_GPURenderPass *pass)
  * @memberof RenderPass
  */
-static RenderPass *init(RenderPass *self, SDL_GPURenderPass *pass, CommandBuffer *cmd) {
+static RenderPass *init(RenderPass *self, CommandBuffer *cmd, SDL_GPURenderPass *pass) {
 
   self = (RenderPass *) super(Object, self, init);
   if (self) {
-    self->pass = pass;
-    assert(self->pass);
     self->cmd = cmd;
     assert(self->cmd);
+    self->pass = pass;
+    assert(self->pass);
   }
 
   return self;

Sources/ObjectivelyGPU/RenderPass.h

@@ -193,15 +193,15 @@ struct RenderPassInterface {
   void (*drawPrimitivesIndirect)(const RenderPass *self, SDL_GPUBuffer *buffer, Uint32 offset, Uint32 drawCount);
 
   /**
-   * @fn RenderPass *RenderPass::init(RenderPass *self, SDL_GPURenderPass *pass, CommandBuffer *cmd)
+   * @fn RenderPass *RenderPass::init(RenderPass *self, CommandBuffer *cmd, SDL_GPURenderPass *pass)
    * @brief Initializes this RenderPass wrapping the given SDL render pass.
    * @param self The RenderPass.
-   * @param pass The SDL render pass to wrap. Must not be NULL.
    * @param cmd The CommandBuffer this pass was begun from.
+   * @param pass The SDL render pass to wrap. Must not be NULL.
    * @return The initialized RenderPass, or NULL on failure.
    * @memberof RenderPass
    */
-  RenderPass *(*init)(RenderPass *self, SDL_GPURenderPass *pass, CommandBuffer *cmd);
+  RenderPass *(*init)(RenderPass *self, CommandBuffer *cmd, SDL_GPURenderPass *pass);
 
   /**
    * @fn void RenderPass::setBlendConstants(const RenderPass *self, SDL_FColor blendConstants)