CommandBuffer.h

Go to the documentation of this file.

/*
 * ObjectivelyGPU: Object oriented graphics framework for SDL3 and C.
 * Copyright (C) 2026 Jay Dolan <jay@jaydolan.com>
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 * claim that you wrote the original software. If you use this software
 * in a product, an acknowledgment in the product documentation would be
 * appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#pragma once
 
#include <Objectively/Object.h>
 
#include <ObjectivelyGPU/Types.h>
 
typedef struct ComputePass ComputePass;
typedef struct CopyPass CopyPass;
typedef struct Fence Fence;
typedef struct Framebuffer Framebuffer;
typedef struct RenderPass RenderPass;
typedef struct RenderDevice RenderDevice;
typedef struct CommandBuffer CommandBuffer;
typedef struct CommandBufferInterface CommandBufferInterface;
typedef struct SwapchainTexture SwapchainTexture;
 
struct SwapchainTexture {
 
  SDL_GPUTexture *texture;
 
  SDL_GPUTextureFormat format;
 
  SDL_Size size;
};
 
struct CommandBuffer {
 
  Object object;
 
  CommandBufferInterface *interface;
 
  SDL_GPUCommandBuffer *commands;
 
  RenderDevice *device;
 
  Object *pass;
 
  bool submitted;
  
  ident data;
};
 
struct CommandBufferInterface {
 
  ObjectInterface objectInterface;
 
  bool (*acquireSwapchainTexture)(const CommandBuffer *self, SwapchainTexture *swapchain);
 
  ComputePass *(*beginComputePass)(CommandBuffer *self, const SDL_GPUStorageTextureReadWriteBinding *storageTextures, Uint32 numStorageTextures, const SDL_GPUStorageBufferReadWriteBinding *storageBuffers, Uint32 numStorageBuffers);
 
  CopyPass *(*beginCopyPass)(CommandBuffer *self);
 
  RenderPass *(*beginRenderPass)(CommandBuffer *self, const SDL_GPUColorTargetInfo *colorTargets, Uint32 numColorTargets, const SDL_GPUDepthStencilTargetInfo *depthStencil);
 
  RenderPass *(*beginRenderPassWithFramebuffer)(CommandBuffer *self, const Framebuffer *framebuffer, SDL_GPULoadOp loadOp, SDL_GPUStoreOp storeOp);
 
  void (*blitTexture)(const CommandBuffer *self, const SDL_GPUBlitInfo *info);
 
  bool (*cancel)(CommandBuffer *self);
 
  void (*generateMipmaps)(const CommandBuffer *self, SDL_GPUTexture *texture);
 
  CommandBuffer *(*initWithCommandBuffer)(CommandBuffer *self, const RenderDevice *device, SDL_GPUCommandBuffer *commands);
 
  void (*insertDebugLabel)(const CommandBuffer *self, const char *text);
 
  void (*popDebugGroup)(const CommandBuffer *self);
 
  void (*pushComputeUniformData)(const CommandBuffer *self, Uint32 slot, const void *data, Uint32 length);
 
  void (*pushDebugGroup)(const CommandBuffer *self, const char *name);
 
  void (*pushFragmentUniformData)(const CommandBuffer *self, Uint32 slot, const void *data, Uint32 length);
 
  void (*pushUniformData)(const CommandBuffer *self, Uint32 slot, const void *data, Uint32 length);
 
  void (*pushVertexUniformData)(const CommandBuffer *self, Uint32 slot, const void *data, Uint32 length);
 
  bool (*submit)(CommandBuffer *self);
 
  Fence *(*submitAndFence)(CommandBuffer *self);
 
  bool (*waitAndAcquireSwapchainTexture)(const CommandBuffer *self, SwapchainTexture *swapchain);
};
 
OBJECTIVELYGPU_EXPORT Class *_CommandBuffer(void);