RenderDevice.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 <stdlib.h>
 
#include <SDL3/SDL_gpu.h>
#include <SDL3/SDL_surface.h>
 
#include <Objectively/Data.h>
#include <Objectively/Object.h>
 
#include <ObjectivelyGPU/CommandBuffer.h>
#include <ObjectivelyGPU/QueryPool.h>
#include <ObjectivelyGPU/Types.h>
 
typedef struct Buffer Buffer;
typedef struct CommandBuffer CommandBuffer;
typedef struct ComputePipeline ComputePipeline;
typedef struct Framebuffer Framebuffer;
typedef struct GPU_FramebufferCreateInfo GPU_FramebufferCreateInfo;
typedef struct GraphicsPipeline GraphicsPipeline;
typedef struct QueryPool QueryPool;
typedef struct RenderDevice RenderDevice;
typedef struct RenderDeviceInterface RenderDeviceInterface;
typedef struct Sampler Sampler;
typedef struct Shader Shader;
typedef struct Texture Texture;
typedef struct TransferBuffer TransferBuffer;
 
struct RenderDevice {
 
  Object object;
 
  RenderDeviceInterface *interface;
 
  SDL_GPUDevice *device;
 
  SDL_Window *window;
  
  SDL_GPUShaderFormat shaderFormats;
 
  float maxAnisotropy;
 
  Framebuffer *framebuffer;
 
  CommandBuffer *commands;
 
  SwapchainTexture swapchain;
 
  TransferBuffer *scratch;
 
  ident data;
};
 
struct RenderDeviceInterface {
 
  ObjectInterface objectInterface;
 
  CommandBuffer *(*acquireCommandBuffer)(const RenderDevice *self);
 
  CommandBuffer *(*beginFrame)(RenderDevice *self);
 
  Buffer *(*createBuffer)(RenderDevice *self, const SDL_GPUBufferCreateInfo *info);
 
  Buffer *(*createBufferWithConstMem)(RenderDevice *self, SDL_GPUBufferUsageFlags usage, const void *mem, Uint32 size);
 
  Buffer *(*createBufferWithData)(RenderDevice *self, SDL_GPUBufferUsageFlags usage, const Data *data);
 
  ComputePipeline *(*createComputePipeline)(RenderDevice *self, const SDL_GPUComputePipelineCreateInfo *info);
 
  Framebuffer *(*createFramebuffer)(RenderDevice *self, const GPU_FramebufferCreateInfo *info);
 
  GraphicsPipeline *(*createGraphicsPipeline)(RenderDevice *self, const SDL_GPUGraphicsPipelineCreateInfo *info);
 
  QueryPool *(*createQueryPool)(RenderDevice *self, const SDL_GPUQueryPoolCreateInfo *info);
 
  Sampler *(*createSampler)(RenderDevice *self, const SDL_GPUSamplerCreateInfo *info);
 
  Sampler *(*createSamplerLinearRepeat)(RenderDevice *self);
 
  Sampler *(*createSamplerLinearClamp)(RenderDevice *self);
 
  Sampler *(*createSamplerNearestClamp)(RenderDevice *self);
 
  Sampler *(*createSamplerShadowCompare)(RenderDevice *self);
 
  Shader *(*createShader)(RenderDevice *self, const SDL_GPUShaderCreateInfo *info);
 
  Texture *(*createTexture)(RenderDevice *self, const SDL_GPUTextureCreateInfo *info, const void *pixels);
 
  Texture *(*createTextureFromSurface)(RenderDevice *self, SDL_Surface *surface, SDL_GPUTextureUsageFlags usage, bool generateMipmaps);
 
  Texture *(*createSolidColorTexture)(RenderDevice *self, SDL_GPUTextureType type, Uint32 layerCount, Uint32 rgba);
 
  TransferBuffer *(*createTransferBuffer)(RenderDevice *self, const SDL_GPUTransferBufferCreateInfo *info);
 
  void (*endFrame)(RenderDevice *self);
 
  Fence *(*endFrameAndFence)(RenderDevice *self);
 
  SDL_GPUTextureFormat (*getSwapchainTextureFormat)(const RenderDevice *self);
 
  RenderDevice *(*init)(RenderDevice *self, const char *driverName);
 
  RenderDevice *(*initWithWindow)(RenderDevice *self, SDL_Window *window, const char *driverName);
 
  Shader *(*loadShader)(RenderDevice *self, const char *name, const SDL_GPUShaderCreateInfo *info);
 
  ComputePipeline *(*loadComputePipeline)(RenderDevice *self, const char *name, const SDL_GPUComputePipelineCreateInfo *info);
 
  GraphicsPipeline *(*loadGraphicsPipeline)(RenderDevice *self,
                                             const char *vertexShaderName, const SDL_GPUShaderCreateInfo *vertexShaderInfo,
                                             const char *fragmentShaderName, const SDL_GPUShaderCreateInfo *fragmentShaderInfo,
                                             SDL_GPUGraphicsPipelineCreateInfo *info);
 
  bool (*setAllowedFramesInFlight)(const RenderDevice *self, Uint32 allowed);
 
  void (*setFramebuffer)(RenderDevice *self, Framebuffer *framebuffer);
 
  bool (*setSwapchainParameters)(const RenderDevice *self, SDL_GPUSwapchainComposition composition, SDL_GPUPresentMode mode);
 
  void (*setWindow)(RenderDevice *self, SDL_Window *window);
 
  TransferBuffer *(*stageData)(RenderDevice *self, const void *data, Uint32 size);
 
  bool (*supportsPresentMode)(const RenderDevice *self, SDL_GPUPresentMode mode);
 
  bool (*supportsSwapchainComposition)(const RenderDevice *self, SDL_GPUSwapchainComposition composition);
 
  bool (*textureSupportsFormat)(const RenderDevice *self, SDL_GPUTextureFormat format, SDL_GPUTextureType type, SDL_GPUTextureUsageFlags usage);
 
  bool (*textureSupportsSampleCount)(const RenderDevice *self, SDL_GPUTextureFormat format, SDL_GPUSampleCount sample_count);
 
  bool (*waitForIdle)(const RenderDevice *self);
 
  bool (*waitForSwapchain)(const RenderDevice *self);
};
 
OBJECTIVELYGPU_EXPORT Class *_RenderDevice(void);