SDL_CreateGPUBuffer(3)

Usage

#include "SDL3/SDL.h"

SDL_GPUBuffer * SDL_CreateGPUBuffer( SDL_GPUDevice *device, const SDL_GPUBufferCreateInfo *createinfo);

Header file

Defined in SDL3/SDL_gpu.h

Overview

The contents of this buffer are undefined until data is written to the buffer.

Note that certain combinations of usage flags are invalid. For example, a buffer cannot have both the VERTEX and INDEX flags.

If you use a STORAGE flag, the data in the buffer must respect std140 layout conventions. In practical terms this means you must ensure that vec3 and vec4 fields are 16-byte aligned.

For better understanding of underlying concepts and memory management with SDL GPU API, you may refer

this blog post ⟨URL: https://moonside.games/posts/sdl-gpu-concepts-cycling/ ⟩

.

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

• SDL_PROP_GPU_BUFFER_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 buffer to create.

Return value

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

SDL_UploadToGPUBuffer(3) Uploads data from a transfer buffer to a buffer. SDL_DownloadFromGPUBuffer(3) Copies data from a buffer to a transfer buffer on the GPU timeline. SDL_CopyGPUBufferToBuffer(3) Performs a buffer-to-buffer copy. SDL_BindGPUVertexBuffers(3) Binds vertex buffers on a command buffer for use with subsequent draw calls. SDL_BindGPUIndexBuffer(3) Binds an index buffer on a command buffer for use with subsequent draw calls. SDL_BindGPUVertexStorageBuffers(3) Binds storage buffers for use on the vertex shader. SDL_BindGPUFragmentStorageBuffers(3) Binds storage buffers for use on the fragment shader. SDL_DrawGPUPrimitivesIndirect(3) Draws data using bound graphics state and with draw parameters set from a buffer. SDL_DrawGPUIndexedPrimitivesIndirect(3) Draws data using bound graphics state with an index buffer enabled and with draw parameters set from a buffer. SDL_BindGPUComputeStorageBuffers(3) Binds storage buffers as readonly for use on the compute pipeline. SDL_DispatchGPUComputeIndirect(3) Dispatches compute work with parameters set from a buffer. SDL_ReleaseGPUBuffer(3) Frees the given buffer as soon as it is safe to do so.

Referred to by

SDL_GPUBuffer(3type) An opaque handle representing a buffer. SDL_SetGPUBufferName(3) Sets an arbitrary string constant to label a buffer. SDL_GPUBufferCreateInfo(3type) A structure specifying the parameters of a buffer. SDL_GPUBufferUsageFlags(3type) Specifies how a buffer is intended to be used by the client.