Man page - sdl_mapgputransferbuffer(3)

Packages contains this manual

Package:  libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:
• libsdl3-doc
• libsdl3-dev

Manual

SDL_MapGPUTransferBuffer

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
RETURN VALUE
AVAILABILITY

---

NAME

SDL_MapGPUTransferBuffer - Maps a transfer buffer into application address space.

HEADER FILE

Defined in SDL3/SDL_gpu.h

SYNOPSIS

#include "SDL3/SDL.h"

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

DESCRIPTION

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.

---