TransferBuffer.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/Object.h>
 
#include <ObjectivelyGPU/Types.h>
 
typedef struct RenderDevice RenderDevice;
typedef struct TransferBuffer TransferBuffer;
typedef struct TransferBufferInterface TransferBufferInterface;
 
struct TransferBuffer {
 
  Object object;
 
  TransferBufferInterface *interface[0];
 
  SDL_GPUTransferBuffer *buffer;
 
  Uint32 size;
 
  RenderDevice *device;
};
 
struct TransferBufferInterface {
 
  ObjectInterface objectInterface;
 
  TransferBuffer *(*initWithDevice)(TransferBuffer *self, RenderDevice *device, const SDL_GPUTransferBufferCreateInfo *info);
 
  void *(*map)(const TransferBuffer *self, bool cycle);
 
  void (*unmap)(const TransferBuffer *self);
 
  void (*write)(const TransferBuffer *self, const void *data, Uint32 size, bool cycle);
};
 
OBJECTIVELYGPU_EXPORT Class *_TransferBuffer(void);