Buffer.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 <SDL3/SDL_gpu.h>
 
#include <Objectively/Data.h>
#include <Objectively/Object.h>
 
#include <ObjectivelyGPU/Types.h>
 
typedef struct CopyPass CopyPass;
typedef struct RenderDevice RenderDevice;
typedef struct Buffer Buffer;
typedef struct BufferInterface BufferInterface;
 
struct Buffer {
 
  Object object;
 
  BufferInterface *interface;
 
  SDL_GPUBuffer *buffer;
 
  SDL_GPUBufferUsageFlags usage;
 
  Uint32 size;
 
  RenderDevice *device;
  
  ident data;
};
 
struct BufferInterface {
 
  ObjectInterface objectInterface;
 
  Buffer *(*initWithConstMem)(Buffer *self, RenderDevice *device, SDL_GPUBufferUsageFlags usage, const void *mem, Uint32 size);
 
  Buffer *(*initWithData)(Buffer *self, RenderDevice *device, SDL_GPUBufferUsageFlags usage, const Data *data);
 
  Buffer *(*initWithDevice)(Buffer *self, RenderDevice *device, const SDL_GPUBufferCreateInfo *info);
 
  void (*setName)(Buffer *self, const char *name);
 
  void (*upload)(Buffer *self, const void *data, Uint32 size, Uint32 offset, bool cycle);
 
  void (*uploadWithPass)(Buffer *self, CopyPass *copyPass, const void *data, Uint32 size, Uint32 offset, bool cycle);
};
 
OBJECTIVELYGPU_EXPORT Class *_Buffer(void);