(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_aligned_alloc

Allocate memory aligned to a specific value.

Header File

Defined in <SDL3/SDL_stdinc.h>

Syntax

SDL_MALLOC void* SDL_aligned_alloc(size_t alignment, size_t size);

Function Parameters

alignment the alignment requested
size the size to allocate

Return Value

Returns a pointer to the aligned memory

Remarks

If alignment is less than the size of void *, then it will be increased to match that.

The returned memory address will be a multiple of the alignment value, and the amount of memory allocated will be a multiple of the alignment value.

The memory returned by this function must be freed with SDL_aligned_free()

Version

This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryStdinc