SDL_CreateGPUTransferBuffer(3)

SDL_CreateGPUTransferBuffer3

Creates a transfer buffer to be used when uploading to or downloading from graphics resources.

Usage

#include "SDL3/SDL.h"

SDL_GPUTransferBuffer * SDL_CreateGPUTransferBuffer( SDL_GPUDevice *device, const SDL_GPUTransferBufferCreateInfo *createinfo);

Header file

Defined in SDL3/SDL_gpu.h

Overview

Download buffers can be particularly expensive to create, so it is good practice to reuse them if data will be downloaded regularly.

There are optional properties that can be provided through props . These are the supported properties:

• SDL_PROP_GPU_TRANSFERBUFFER_CREATE_NAME_STRING :
a name that can be displayed in debugging tools.

Function parameters

device

a GPU Context.

createinfo

a struct describing the state of the transfer buffer to create.

Return value

( SDL_GPUTransferBuffer
*) Returns a transfer buffer on success, or NULL on failure; call SDL_GetError () for more information.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.