(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_MapGPUTransferBuffer

Maps a transfer buffer into application address space.

Header File

Defined in <SDL3/SDL_gpu.h>

Syntax

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

Function Parameters

SDL_GPUDevice *	device	a GPU context.
SDL_GPUTransferBuffer *	transfer_buffer	a transfer buffer.
bool	cycle	if true, cycles the transfer buffer if it is already bound.

Return Value

(void *) Returns the address of the mapped transfer buffer memory, or NULL on failure; call SDL_GetError() for more information.

Remarks

You must unmap the transfer buffer before encoding upload commands.

Version

This function is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIFunction, CategoryGPU

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.