SDL_IOFromConstMem3
Use this function to prepare a read-only memory buffer for use with sdl_iostream .
Usage
#include "SDL3/SDL.h"
SDL_IOStream * SDL_IOFromConstMem(const 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. 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.
Function parameters
mem
|
a pointer to a read-only buffer to feed an |
|---|---|
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.