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

SDL_IOFromConstMem

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

Header File

Defined in <SDL3/SDL_iostream.h>

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 if it fails; 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.

Version

This function is available since SDL 3.0.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryIOStream


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.