Framebuffer.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 Framebuffer Framebuffer;
typedef struct FramebufferInterface FramebufferInterface;
typedef struct Texture Texture;
 
#define GPU_MAX_COLOR_TARGETS 4
 
typedef struct GPU_FramebufferAttachment {
 
  SDL_GPUTextureFormat format;
 
  union {
    SDL_FColor clearColor;
 
    float clearDepth;
  };
 
  bool doubleBuffered;
 
  Uint32 layerCount;
 
  Texture *textures[2];
 
  Texture *resolveTextures[2];
 
} GPU_FramebufferAttachment;
 
typedef struct GPU_FramebufferCreateInfo {
 
  SDL_Size size;
 
  GPU_FramebufferAttachment colorAttachments[GPU_MAX_COLOR_TARGETS];
 
  Uint32 numColorTargets;
 
  GPU_FramebufferAttachment depthAttachment;
 
  SDL_GPUSampleCount sampleCount;
 
} GPU_FramebufferCreateInfo;
 
struct Framebuffer {
 
  Object object;
 
  FramebufferInterface *interface[0];
 
  RenderDevice *device;
 
  SDL_Size size;
 
  SDL_GPUSampleCount sampleCount;
 
  GPU_FramebufferAttachment colorAttachments[GPU_MAX_COLOR_TARGETS];
 
  Uint32 numColorAttachments;
 
  GPU_FramebufferAttachment depthAttachment;
 
  Uint32 frame;
  
  ident data;
};
 
struct FramebufferInterface {
 
  ObjectInterface objectInterface;
 
  SDL_GPUColorTargetInfo (*colorTargetInfo)(const Framebuffer *self, Uint32 index, SDL_GPULoadOp loadOp, SDL_GPUStoreOp storeOp);
 
  SDL_GPUColorTargetInfo (*colorTargetInfoForLayer)(const Framebuffer *self, Uint32 index, Uint32 layer, SDL_GPULoadOp loadOp, SDL_GPUStoreOp storeOp);
 
  SDL_GPUDepthStencilTargetInfo (*depthTargetInfo)(const Framebuffer *self, SDL_GPULoadOp loadOp, SDL_GPUStoreOp storeOp);
 
  void (*pipelineTargetInfo)(const Framebuffer *self, const SDL_GPUColorTargetBlendState *blendStates,
                             SDL_GPUColorTargetDescription *descriptions, SDL_GPUGraphicsPipelineTargetInfo *targetInfo);
 
  Framebuffer *(*initWithDevice)(Framebuffer *self, RenderDevice *device, const GPU_FramebufferCreateInfo *info);
 
  Texture *(*resolveColorTexture)(const Framebuffer *self, Uint32 index);
 
  Texture *(*previousColorTexture)(const Framebuffer *self, Uint32 index);
 
  Texture *(*resolveDepthTexture)(const Framebuffer *self);
 
  bool (*resize)(Framebuffer *self, const SDL_Size *size);
 
  void (*swap)(Framebuffer *self);
};
 
OBJECTIVELYGPU_EXPORT Class *_Framebuffer(void);