Remove superfluous window param from renderDevice methods.

Author: jdolan

Examples/Hello.c

@@ -240,7 +240,7 @@ SDL_AppResult SDL_AppInit(void **appState, int argc, char *argv[]) {
   int w = 0, h = 0;
   SDL_GetWindowSizeInPixels(app->window, &w, &h);
 
-  const SDL_GPUTextureFormat colorFormat = $(app->renderDevice, getSwapchainTextureFormat, app->window);
+  const SDL_GPUTextureFormat colorFormat = $(app->renderDevice, getSwapchainTextureFormat);
   app->framebuffer = $(app->renderDevice, createFramebuffer, &(GPU_FramebufferCreateInfo) {
     .size = MakeSize(w, h),
     .colorFormat = colorFormat,

Examples/HelloCompute.c

@@ -194,7 +194,7 @@ SDL_AppResult SDL_AppInit(void **appState, int argc, char *argv[]) {
   int w = 0, h = 0;
   SDL_GetWindowSizeInPixels(app->window, &w, &h);
 
-  const SDL_GPUTextureFormat colorFormat = $(app->renderDevice, getSwapchainTextureFormat, app->window);
+  const SDL_GPUTextureFormat colorFormat = $(app->renderDevice, getSwapchainTextureFormat);
   app->framebuffer = $(app->renderDevice, createFramebuffer, &(GPU_FramebufferCreateInfo) {
     .size = MakeSize(w, h),
     .colorFormat = colorFormat,

Sources/ObjectivelyGPU/Buffer.c

@@ -150,7 +150,7 @@ static void upload(Buffer *self, const void *data, Uint32 size, Uint32 offset, b
     cycle);
 
   release(copyPass);
-  $(self->device, submit, commands);
+  $(commands, submit);
   release(commands);
   SDL_ReleaseGPUTransferBuffer(self->device->device, tbuf);
 }

Sources/ObjectivelyGPU/CommandBuffer.c

@@ -56,11 +56,13 @@ static bool acquireSwapchainTexture(const CommandBuffer *self, SwapchainTexture
 
   assert(swapchain);
 
-  return SDL_AcquireGPUSwapchainTexture(self->commands,
-                                        self->device->window,
-                                        &swapchain->texture,
-                                        (Uint32 *) &swapchain->size.w,
-                                        (Uint32 *) &swapchain->size.h);
+  Uint32 w = 0, h = 0;
+  const bool ok = SDL_AcquireGPUSwapchainTexture(self->commands,
+                                                 self->device->window,
+                                                 &swapchain->texture,
+                                                 &w, &h);
+  swapchain->size = (SDL_Size) { (int) w, (int) h };
+  return ok;
 }
 
 /**
@@ -259,11 +261,13 @@ static bool waitAndAcquireSwapchainTexture(const CommandBuffer *self, SwapchainT
 
   assert(swapchain);
 
-  return SDL_WaitAndAcquireGPUSwapchainTexture(self->commands,
-                                               self->device->window,
-                                               &swapchain->texture,
-                                               (Uint32 *) &swapchain->size.w,
-                                               (Uint32 *) &swapchain->size.h);
+  Uint32 w = 0, h = 0;
+  const bool ok = SDL_WaitAndAcquireGPUSwapchainTexture(self->commands,
+                                                        self->device->window,
+                                                        &swapchain->texture,
+                                                        &w, &h);
+  swapchain->size = (SDL_Size) { (int) w, (int) h };
+  return ok;
 }
 
 #pragma mark - Class lifecycle

Sources/ObjectivelyGPU/RenderDevice.c

@@ -40,6 +40,19 @@
 #include "Shader.h"
 #include "Texture.h"
 
+/**
+ * @brief Whether to create the `SDL_GPUDevice` with backend validation/debug layers.
+ * @details Defaults to enabled unless `NDEBUG` is defined (i.e. on for debug builds,
+ *   off for release). Override by defining `GPU_DEBUG` to `true` or `false` at build time.
+ */
+#ifndef GPU_DEBUG
+ #ifdef NDEBUG
+  #define GPU_DEBUG false
+ #else
+  #define GPU_DEBUG true
+ #endif
+#endif
+
 #define _Class _RenderDevice
 
 #pragma mark - Object
@@ -240,8 +253,14 @@ static Texture *createTextureFromSurface(RenderDevice *self, SDL_Surface *surfac
 
   return $(alloc(Texture), initWithSurface, self, surface, usage);
 }
-static SDL_GPUTextureFormat getSwapchainTextureFormat(const RenderDevice *self, SDL_Window *window) {
-  return SDL_GetGPUSwapchainTextureFormat(self->device, window);
+
+/**
+ * @fn SDL_GPUTextureFormat RenderDevice::getSwapchainTextureFormat(const RenderDevice *self)
+ * @memberof RenderDevice
+ */
+static SDL_GPUTextureFormat getSwapchainTextureFormat(const RenderDevice *self) {
+  assert(self->window);
+  return SDL_GetGPUSwapchainTextureFormat(self->device, self->window);
 }
 
 /**
@@ -258,7 +277,7 @@ static RenderDevice *init(RenderDevice *self) {
       SDL_GPU_SHADERFORMAT_SPIRV |
       SDL_GPU_SHADERFORMAT_DXIL;
 
-    self->device = SDL_CreateGPUDevice(formats, false, NULL);
+    self->device = SDL_CreateGPUDevice(formats, GPU_DEBUG, NULL);
     GPU_Assert(self->device, "SDL_CreateGPUDevice");
   }
 
@@ -356,8 +375,9 @@ static void setFramebuffer(RenderDevice *self, Framebuffer *framebuffer) {
  * @fn bool RenderDevice::setSwapchainParameters(const RenderDevice *self, SDL_Window *window, SDL_GPUSwapchainComposition composition, SDL_GPUPresentMode mode)
  * @memberof RenderDevice
  */
-static bool setSwapchainParameters(const RenderDevice *self, SDL_Window *window, SDL_GPUSwapchainComposition composition, SDL_GPUPresentMode mode) {
-  return SDL_SetGPUSwapchainParameters(self->device, window, composition, mode);
+static bool setSwapchainParameters(const RenderDevice *self, SDL_GPUSwapchainComposition composition, SDL_GPUPresentMode mode) {
+  assert(self->window);
+  return SDL_SetGPUSwapchainParameters(self->device, self->window, composition, mode);
 }
 
 /**
@@ -383,21 +403,21 @@ static void setWindow(RenderDevice *self, SDL_Window *window) {
 }
 
 /**
- * @fn void RenderDevice::submit(const RenderDevice *self, CommandBuffer *commands)
+ * @fn bool RenderDevice::supportsPresentMode(const RenderDevice *self, SDL_GPUPresentMode mode)
  * @memberof RenderDevice
  */
-static void submit(const RenderDevice *self, CommandBuffer *commands) {
-  assert(commands);
-  $(commands, submit);
+static bool supportsPresentMode(const RenderDevice *self, SDL_GPUPresentMode mode) {
+  assert(self->window);
+  return SDL_WindowSupportsGPUPresentMode(self->device, self->window, mode);
 }
 
 /**
- * @fn SDL_GPUFence *RenderDevice::submitAndFence(const RenderDevice *self, CommandBuffer *commands)
+ * @fn bool RenderDevice::supportsSwapchainComposition(const RenderDevice *self, SDL_GPUSwapchainComposition composition)
  * @memberof RenderDevice
  */
-static SDL_GPUFence *submitAndFence(const RenderDevice *self, CommandBuffer *commands) {
-  assert(commands);
-  return $(commands, submitAndFence);
+static bool supportsSwapchainComposition(const RenderDevice *self, SDL_GPUSwapchainComposition composition) {
+  assert(self->window);
+  return SDL_WindowSupportsGPUSwapchainComposition(self->device, self->window, composition);
 }
 
 /**
@@ -441,27 +461,12 @@ static bool waitForIdle(const RenderDevice *self) {
 }
 
 /**
- * @fn bool RenderDevice::waitForSwapchain(const RenderDevice *self, SDL_Window *window)
- * @memberof RenderDevice
- */
-static bool waitForSwapchain(const RenderDevice *self, SDL_Window *window) {
-  return SDL_WaitForGPUSwapchain(self->device, window);
-}
-
-/**
- * @fn bool RenderDevice::windowSupportsPresentMode(const RenderDevice *self, SDL_Window *window, SDL_GPUPresentMode mode)
- * @memberof RenderDevice
- */
-static bool windowSupportsPresentMode(const RenderDevice *self, SDL_Window *window, SDL_GPUPresentMode mode) {
-  return SDL_WindowSupportsGPUPresentMode(self->device, window, mode);
-}
-
-/**
- * @fn bool RenderDevice::windowSupportsSwapchainComposition(const RenderDevice *self, SDL_Window *window, SDL_GPUSwapchainComposition composition)
+ * @fn bool RenderDevice::waitForSwapchain(const RenderDevice *self)
  * @memberof RenderDevice
  */
-static bool windowSupportsSwapchainComposition(const RenderDevice *self, SDL_Window *window, SDL_GPUSwapchainComposition composition) {
-  return SDL_WindowSupportsGPUSwapchainComposition(self->device, window, composition);
+static bool waitForSwapchain(const RenderDevice *self) {
+  assert(self->window);
+  return SDL_WaitForGPUSwapchain(self->device, self->window);
 }
 
 #pragma mark - Class lifecycle
@@ -500,16 +505,14 @@ static void initialize(Class *clazz) {
   ((RenderDeviceInterface *) clazz->interface)->setFramebuffer = setFramebuffer;
   ((RenderDeviceInterface *) clazz->interface)->setSwapchainParameters = setSwapchainParameters;
   ((RenderDeviceInterface *) clazz->interface)->setWindow = setWindow;
-  ((RenderDeviceInterface *) clazz->interface)->submit = submit;
-  ((RenderDeviceInterface *) clazz->interface)->submitAndFence = submitAndFence;
+  ((RenderDeviceInterface *) clazz->interface)->supportsPresentMode = supportsPresentMode;
+  ((RenderDeviceInterface *) clazz->interface)->supportsSwapchainComposition = supportsSwapchainComposition;
   ((RenderDeviceInterface *) clazz->interface)->textureSupportsFormat = textureSupportsFormat;
   ((RenderDeviceInterface *) clazz->interface)->textureSupportsSampleCount = textureSupportsSampleCount;
   ((RenderDeviceInterface *) clazz->interface)->unmapTransferBuffer = unmapTransferBuffer;
   ((RenderDeviceInterface *) clazz->interface)->waitForFences = waitForFences;
   ((RenderDeviceInterface *) clazz->interface)->waitForIdle = waitForIdle;
   ((RenderDeviceInterface *) clazz->interface)->waitForSwapchain = waitForSwapchain;
-  ((RenderDeviceInterface *) clazz->interface)->windowSupportsPresentMode = windowSupportsPresentMode;
-  ((RenderDeviceInterface *) clazz->interface)->windowSupportsSwapchainComposition = windowSupportsSwapchainComposition;
 }
 
 /**

Sources/ObjectivelyGPU/RenderDevice.h

@@ -295,16 +295,15 @@ struct RenderDeviceInterface {
   void (*endFrame)(RenderDevice *self);
 
   /**
-   * @fn SDL_GPUTextureFormat RenderDevice::getSwapchainTextureFormat(const RenderDevice *self, SDL_Window *window)
-   * @brief Returns the pixel format of the swapchain for the given window.
+   * @fn SDL_GPUTextureFormat RenderDevice::getSwapchainTextureFormat(const RenderDevice *self)
+   * @brief Returns the pixel format of this device's swapchain.
    * @details Useful for configuring render-pass colour target formats or creating
-   *   pipelines that write to the swapchain.
+   *   pipelines that write to the swapchain. The device must have a window claimed.
    * @param self The RenderDevice.
-   * @param window The window whose swapchain format to query.
    * @return The `SDL_GPUTextureFormat` of the window's swapchain.
    * @memberof RenderDevice
    */
-  SDL_GPUTextureFormat (*getSwapchainTextureFormat)(const RenderDevice *self, SDL_Window *window);
+  SDL_GPUTextureFormat (*getSwapchainTextureFormat)(const RenderDevice *self);
 
   /**
    * @fn RenderDevice *RenderDevice::init(RenderDevice *self)
@@ -436,18 +435,17 @@ struct RenderDeviceInterface {
   void (*setFramebuffer)(RenderDevice *self, Framebuffer *framebuffer);
 
   /**
-   * @fn bool RenderDevice::setSwapchainParameters(const RenderDevice *self, SDL_Window *window, SDL_GPUSwapchainComposition composition, SDL_GPUPresentMode mode)
-   * @brief Configures swapchain composition and present mode for a window.
-   * @details Use `windowSupportsSwapchainComposition` and `windowSupportsPresentMode`
+   * @fn bool RenderDevice::setSwapchainParameters(const RenderDevice *self, SDL_GPUSwapchainComposition composition, SDL_GPUPresentMode mode)
+   * @brief Configures swapchain composition and present mode for this device's window.
+   * @details Use `supportsSwapchainComposition` and `supportsPresentMode`
    *   to guard against unsupported combinations before calling this.
    * @param self The RenderDevice.
-   * @param window The window whose swapchain to configure.
    * @param composition Colour space / HDR composition mode.
    * @param mode Presentation mode (vsync, mailbox, immediate, etc.).
    * @return `true` on success, `false` if the combination is unsupported.
    * @memberof RenderDevice
    */
-  bool (*setSwapchainParameters)(const RenderDevice *self, SDL_Window *window, SDL_GPUSwapchainComposition composition, SDL_GPUPresentMode mode);
+  bool (*setSwapchainParameters)(const RenderDevice *self, SDL_GPUSwapchainComposition composition, SDL_GPUPresentMode mode);
 
   /**
    * @fn void RenderDevice::setWindow(RenderDevice *self, SDL_Window *window)
@@ -462,28 +460,24 @@ struct RenderDeviceInterface {
   void (*setWindow)(RenderDevice *self, SDL_Window *window);
 
   /**
-   * @fn void RenderDevice::submit(const RenderDevice *self, CommandBuffer *commands)
-   * @brief Submits a recorded CommandBuffer to the GPU for execution.
-   * @details The CommandBuffer's underlying `SDL_GPUCommandBuffer` is consumed;
-   *   the caller must still `release` the CommandBuffer object.
+   * @fn bool RenderDevice::supportsPresentMode(const RenderDevice *self, SDL_GPUPresentMode mode)
+   * @brief Queries whether this device's swapchain supports the given present mode.
    * @param self The RenderDevice.
-   * @param commands The CommandBuffer to submit.
+   * @param mode The present mode to test.
+   * @return `true` if the present mode is supported.
    * @memberof RenderDevice
    */
-  void (*submit)(const RenderDevice *self, CommandBuffer *commands);
+  bool (*supportsPresentMode)(const RenderDevice *self, SDL_GPUPresentMode mode);
 
   /**
-   * @fn SDL_GPUFence *RenderDevice::submitAndFence(const RenderDevice *self, CommandBuffer *commands)
-   * @brief Submits a CommandBuffer and returns a fence for CPU synchronisation.
-   * @details The fence becomes signaled when all GPU work in @p commands has completed.
-   *   Use `queryFence` or `waitForFences` to poll or block on it, then release it
-   *   with `releaseFence`.
+   * @fn bool RenderDevice::supportsSwapchainComposition(const RenderDevice *self, SDL_GPUSwapchainComposition composition)
+   * @brief Queries whether this device's swapchain supports the given composition (colour space / HDR mode).
    * @param self The RenderDevice.
-   * @param commands The CommandBuffer to submit.
-   * @return A new `SDL_GPUFence`. GPU_Asserts on failure. Release with `releaseFence`.
+   * @param composition The swapchain composition to test.
+   * @return `true` if the composition is supported.
    * @memberof RenderDevice
    */
-  SDL_GPUFence *(*submitAndFence)(const RenderDevice *self, CommandBuffer *commands);
+  bool (*supportsSwapchainComposition)(const RenderDevice *self, SDL_GPUSwapchainComposition composition);
 
   /**
    * @fn bool RenderDevice::textureSupportsFormat(const RenderDevice *self, SDL_GPUTextureFormat format, SDL_GPUTextureType type, SDL_GPUTextureUsageFlags usage)
@@ -543,36 +537,13 @@ struct RenderDeviceInterface {
   bool (*waitForIdle)(const RenderDevice *self);
 
   /**
-   * @fn bool RenderDevice::waitForSwapchain(const RenderDevice *self, SDL_Window *window)
-   * @brief Blocks until the swapchain for @p window is available for the next frame.
+   * @fn bool RenderDevice::waitForSwapchain(const RenderDevice *self)
+   * @brief Blocks until this device's swapchain is available for the next frame.
    * @param self The RenderDevice.
-   * @param window The window whose swapchain to wait for.
    * @return `true` on success, `false` on error.
    * @memberof RenderDevice
    */
-  bool (*waitForSwapchain)(const RenderDevice *self, SDL_Window *window);
-
-  /**
-   * @fn bool RenderDevice::windowSupportsPresentMode(const RenderDevice *self, SDL_Window *window, SDL_GPUPresentMode mode)
-   * @brief Queries whether a window's swapchain supports the given present mode.
-   * @param self The RenderDevice.
-   * @param window The window to query.
-   * @param mode The present mode to test.
-   * @return `true` if the present mode is supported for @p window.
-   * @memberof RenderDevice
-   */
-  bool (*windowSupportsPresentMode)(const RenderDevice *self, SDL_Window *window, SDL_GPUPresentMode mode);
-
-  /**
-   * @fn bool RenderDevice::windowSupportsSwapchainComposition(const RenderDevice *self, SDL_Window *window, SDL_GPUSwapchainComposition composition)
-   * @brief Queries whether a window supports the given swapchain composition (colour space / HDR mode).
-   * @param self The RenderDevice.
-   * @param window The window to query.
-   * @param composition The swapchain composition to test.
-   * @return `true` if the composition is supported for @p window.
-   * @memberof RenderDevice
-   */
-  bool (*windowSupportsSwapchainComposition)(const RenderDevice *self, SDL_Window *window, SDL_GPUSwapchainComposition composition);
+  bool (*waitForSwapchain)(const RenderDevice *self);
 };
 
 /**

Sources/ObjectivelyGPU/Texture.c

@@ -109,7 +109,7 @@ static Texture *initWithDevice(Texture *self, RenderDevice *device, const SDL_GP
         false);
 
       release(copyPass);
-      $(device, submit, commands);
+      $(commands, submit);
       release(commands);
       SDL_ReleaseGPUTransferBuffer(device->device, tbuf);
     }