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

SDL_IOFromConstMem

Use this function to prepare a read-only memory buffer for use with SDL_IOStream.

Header File

Syntax

SDL_IOStream * SDL_IOFromConstMem(const void *mem, size_t size);

Function Parameters

const void *	mem	a pointer to a read-only buffer to feed an SDL_IOStream stream.
size_t	size	the buffer size, in bytes.

Return Value

(SDL_IOStream *) Returns a pointer to a new SDL_IOStream structure or NULL on failure; call SDL_GetError() for more information.

Remarks

This function sets up an SDL_IOStream struct based on a memory area of a certain size. It assumes the memory area is not writable.

Attempting to write to this SDL_IOStream stream will report an error without writing to the memory buffer.

This memory buffer is not copied by the SDL_IOStream; the pointer you provide must remain valid until you close the stream. Closing the stream will not free the original buffer.

If you need to write to a memory buffer, you should use SDL_IOFromMem() with a writable buffer of memory instead.

The following properties will be set at creation time by SDL:

SDL_PROP_IOSTREAM_MEMORY_POINTER: this will be the mem parameter that was passed to this function.
SDL_PROP_IOSTREAM_MEMORY_SIZE_NUMBER: this will be the size parameter that was passed to this function.

Version

This function is available since SDL 3.1.3.