SDL_MapGPUTransferBuffer(3)

SDL_MapGPUTransferBuffer3

Maps a transfer buffer into application address space.

Usage

#include "SDL3/SDL.h"

void * SDL_MapGPUTransferBuffer( SDL_GPUDevice *device, SDL_GPUTransferBuffer *transfer_buffer, bool cycle);

Header file

Defined in SDL3/SDL_gpu.h

Overview

You must unmap the transfer buffer before encoding upload commands. The memory is owned by the graphics driver - do NOT call SDL_free () on the returned pointer.

Function parameters

device

a GPU context.

transfer_buffer

a transfer buffer.

cycle

if true, cycles the transfer buffer if it is already bound.

Return value

Returns the address of the mapped transfer buffer memory, 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.