SDL_IOFromMem(3)

SDL_IOFromMem3

Use this function to prepare a read-write memory buffer for use with sdl_iostream .

Usage

#include "SDL3/SDL.h"

SDL_IOStream * SDL_IOFromMem(void *mem, size_t size);

Header file

Defined in SDL3/SDL_iostream.h

Overview

This function sets up an SDL_IOStream
struct based on a memory area of a certain size, for both read and write access.

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 make sure the SDL_IOStream
never writes to the memory buffer, you should use

SDL_IOFromConstMem () with a read-only 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.

Function parameters

mem

a pointer to a buffer to feed an SDL_IOStream
stream.

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.

Thread safety

It is safe to call this function from any thread.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.