Cosmetics

Author: jdolan

Documentation/index.md

@@ -11,8 +11,7 @@ Object oriented graphics framework for SDL3 and C.
 ## Features
 
 - **Cross-platform** support for Android, iOS, macOS, Linux and Windows
-- **RenderDevice** owns the swapchain — drive frames with a simple `beginFrame` / `endFrame` loop and an unambiguous order of operations
-- **Resource objects** with automatic lifecycle — Buffer, Texture, Sampler, Shader, GraphicsPipeline and ComputePipeline initialize and tear themselves down
+- **Resource objects** with automatic lifecycle — Buffer, Texture, Sampler, Shader, GraphicsPipeline ComputePipeline and RenderDevice initialize and tear themselves down
 - **Typed passes**: RenderPass, ComputePass and CopyPass with command-lifecycle validation that catches mistakes upfront
 - **Framebuffer** abstracts multiple render targets, depth, and MSAA with automatic resolve — convenience without forfeiting the low-level API
 - **Shaders** loaded by name, with the formats supported by your platform
@@ -26,14 +25,14 @@ Uploading an image to the GPU is a single call — the staging buffer and copy p
 
 ```c
 SDL_Surface *surface = IMG_Load("crate.png");
-Texture *texture = $(renderDevice, createTextureFromSurface, surface, SDL_GPU_TEXTUREUSAGE_SAMPLER);
+Texture *texture = $(device, createTextureFromSurface, surface, SDL_GPU_TEXTUREUSAGE_SAMPLER);
 SDL_DestroySurface(surface);
 ```
 
 And a whole frame — acquire the swapchain, clear, draw a multisampled scene, resolve, and present:
 
 ```c
-CommandBuffer *commands = $(renderDevice, beginFrame);
+CommandBuffer *commands = $(device, beginFrame);
 if (commands) {
 
   const SDL_FColor clearColor = { 0.1f, 0.1f, 0.2f, 1.f };
@@ -46,7 +45,7 @@ if (commands) {
   $(pass, drawPrimitives, 36, 1, 0, 0);
   pass = release(pass);
 
-  $(renderDevice, endFrame);
+  $(device, endFrame);
 }
 ```
 

README.md

@@ -13,8 +13,7 @@ Built on [Objectively](https://github.com/jdolan/Objectively) and [SDL_gpu](http
 
 ## Features
  * **Cross-platform** support for Android, iOS, macOS, Linux and Windows
- * **RenderDevice** owns the swapchain — drive frames with a simple `beginFrame` / `endFrame` loop and an unambiguous order of operations
- * **Resource objects** with automatic lifecycle — Buffer, Texture, Sampler, Shader, GraphicsPipeline and ComputePipeline initialize and tear themselves down
+ * **Resource objects** with automatic lifecycle — Buffer, Texture, Sampler, Shader, GraphicsPipeline, ComputePipeline and RenderDevice initialize and tear themselves down
  * **Typed passes**: RenderPass, ComputePass and CopyPass with command-lifecycle validation that catches mistakes upfront
  * **Framebuffer** abstracts multiple render targets, depth, and MSAA with automatic resolve — convenience without forfeiting the low-level API
  * **Shaders** loaded by name, with the formats supported by your platform
@@ -28,14 +27,14 @@ Uploading an image to the GPU is a single call — the staging buffer and copy p
 
 ```c
 SDL_Surface *surface = IMG_Load("crate.png");
-Texture *texture = $(renderDevice, createTextureFromSurface, surface, SDL_GPU_TEXTUREUSAGE_SAMPLER);
+Texture *texture = $(device, createTextureFromSurface, surface, SDL_GPU_TEXTUREUSAGE_SAMPLER);
 SDL_DestroySurface(surface);
 ```
 
 And a whole frame — acquire the swapchain, clear, draw a multisampled scene, resolve, and present:
 
 ```c
-CommandBuffer *commands = $(renderDevice, beginFrame);
+CommandBuffer *commands = $(device, beginFrame);
 if (commands) {
 
   const SDL_FColor clearColor = { 0.1f, 0.1f, 0.2f, 1.f };
@@ -48,7 +47,7 @@ if (commands) {
   $(pass, drawPrimitives, 36, 1, 0, 0);
   pass = release(pass);
 
-  $(renderDevice, endFrame);
+  $(device, endFrame);
 }
 ```
 

Sources/ObjectivelyGPU/RenderDevice.c

@@ -366,13 +366,12 @@ static SDL_GPUTransferBuffer *createTransferBuffer(const RenderDevice *self, con
 }
 
 /**
- * @fn Texture *RenderDevice::createTextureFromSurface(RenderDevice *self, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage)
+ * @fn Texture *RenderDevice::createTextureFromSurface(RenderDevice *self, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage, bool generateMipmaps)
  * @memberof RenderDevice
  */
-static Texture *createTextureFromSurface(RenderDevice *self, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage,
-                                          bool mipmaps) {
+static Texture *createTextureFromSurface(RenderDevice *self, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage, bool generateMipmaps) {
 
-  return $(alloc(Texture), initWithSurface, self, surface, usage, mipmaps);
+  return $(alloc(Texture), initWithSurface, self, surface, usage, generateMipmaps);
 }
 
 /**

Sources/ObjectivelyGPU/RenderDevice.h

@@ -327,7 +327,7 @@ struct RenderDeviceInterface {
   Texture *(*createTexture)(RenderDevice *self, const SDL_GPUTextureCreateInfo *info, const void *pixels);
 
   /**
-   * @fn Texture *RenderDevice::createTextureFromSurface(RenderDevice *self, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage, bool mipmaps)
+   * @fn Texture *RenderDevice::createTextureFromSurface(RenderDevice *self, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage, bool generateMipmaps)
    * @brief Creates a Texture from an `SDL_Surface`, uploading pixel data immediately.
    * @details Convenience factory for `Texture::initWithSurface`. Converts @p surface
    *   to `SDL_PIXELFORMAT_RGBA32` if needed and uploads it as
@@ -339,7 +339,7 @@ struct RenderDeviceInterface {
    * @return A new, retained Texture. GPU_Asserts on failure. Free with `release`.
    * @memberof RenderDevice
    */
-  Texture *(*createTextureFromSurface)(RenderDevice *self, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage, bool mipmaps);
+  Texture *(*createTextureFromSurface)(RenderDevice *self, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage, bool generateMipmaps);
 
   /**
    * @fn Texture *RenderDevice::createSolidColorTexture(RenderDevice *self, SDL_GPUTextureType type, Uint32 layerCount, Uint32 rgba)

Sources/ObjectivelyGPU/Texture.c

@@ -154,12 +154,7 @@ static Texture *initWithDevice(Texture *self, RenderDevice *device, const SDL_GP
     self->sampleCount = info->sample_count;
 
     if (pixels) {
-      // Tightly-packed source: SDL_CalculateGPUTextureFormatSize accounts for
-      // block-compressed formats, so this is correct for BCn/ASTC/etc. as well as
-      // plain texel formats (where a naive width*height*texelSize would also work).
-      const Uint32 size = SDL_CalculateGPUTextureFormatSize(info->format,
-        info->width, info->height, info->layer_count_or_depth);
-
+      const Uint32 size = SDL_CalculateGPUTextureFormatSize(info->format, info->width, info->height, info->layer_count_or_depth);
       uploadPixels(self, pixels, size, info->width);
     }
   }
@@ -168,11 +163,10 @@ static Texture *initWithDevice(Texture *self, RenderDevice *device, const SDL_GP
 }
 
 /**
- * @fn Texture *Texture::initWithSurface(Texture *self, RenderDevice *device, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage)
+ * @fn Texture *Texture::initWithSurface(Texture *self, RenderDevice *device, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage, bool generateMipmaps)
  * @memberof Texture
  */
-static Texture *initWithSurface(Texture *self, RenderDevice *device, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage,
-                                 bool mipmaps) {
+static Texture *initWithSurface(Texture *self, RenderDevice *device, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage, bool generateMipmaps) {
 
   assert(device);
   assert(surface);
@@ -182,8 +176,8 @@ static Texture *initWithSurface(Texture *self, RenderDevice *device, SDL_Surface
     : SDL_ConvertSurface(surface, SDL_PIXELFORMAT_RGBA32);
   GPU_Assert(rgba, "SDL_ConvertSurface");
 
-  const Uint32 numLevels = mipmaps ? (Uint32) (floorf(log2f((float) SDL_min(rgba->w, rgba->h))) + 1) : 1;
-  if (mipmaps) {
+  const Uint32 numLevels = generateMipmaps ? (Uint32) (floorf(log2f((float) SDL_min(rgba->w, rgba->h))) + 1) : 1;
+  if (generateMipmaps) {
     usage |= SDL_GPU_TEXTUREUSAGE_COLOR_TARGET;
   }
 
@@ -207,7 +201,7 @@ static Texture *initWithSurface(Texture *self, RenderDevice *device, SDL_Surface
       (Uint32) rgba->pitch * (Uint32) rgba->h,
       (Uint32) rgba->pitch / bytesPerPixel);
 
-    if (mipmaps) {
+    if (generateMipmaps) {
       // Mipmap generation is not a copy-pass operation and must run outside any pass,
       // so it gets its own one-shot command buffer after the base level upload above.
       CommandBuffer *commands = $(device, acquireCommandBuffer);

Sources/ObjectivelyGPU/Texture.h

@@ -151,7 +151,7 @@ struct TextureInterface {
   Texture *(*initWithDevice)(Texture *self, RenderDevice *device, const SDL_GPUTextureCreateInfo *info, const void *pixels);
 
   /**
-   * @fn Texture *Texture::initWithSurface(Texture *self, RenderDevice *device, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage, bool mipmaps)
+   * @fn Texture *Texture::initWithSurface(Texture *self, RenderDevice *device, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage, bool generateMipmaps)
    * @brief Initializes this Texture from an `SDL_Surface`, uploading its pixels immediately.
    * @details Converts @p surface to `SDL_PIXELFORMAT_RGBA32` if needed, derives the
    *   dimensions from the surface, and uploads as `SDL_GPU_TEXTUREFORMAT_R8G8B8A8_UNORM`.
@@ -168,7 +168,7 @@ struct TextureInterface {
    * @return The initialized Texture, or `NULL` on failure.
    * @memberof Texture
    */
-  Texture *(*initWithSurface)(Texture *self, RenderDevice *device, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage, bool mipmaps);
+  Texture *(*initWithSurface)(Texture *self, RenderDevice *device, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage, bool generateMipmaps);
 
   /**
    * @fn void Texture::setName(Texture *self, const char *name)