mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-09-05 19:08:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

Browse Source
This commit is contained in:
SDL Wiki Bot
2024-03-18 04:28:30 +00:00
parent a1a0156756
commit fc26d5d328
1 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
include/SDL3/SDL_iostream.h
View File

@@ -265,11 +265,16 @@ extern DECLSPEC SDL_IOStream *SDLCALL SDL_IOFromMem(void *mem, size_t size);
extern DECLSPEC SDL_IOStream *SDLCALL SDL_IOFromConstMem(const void *mem, size_t size);
/**
* Use this function to create an SDL_IOStream that is backed by dynamically allocated memory.
* Use this function to create an SDL_IOStream that is backed by dynamically
* allocated memory.
*
* This supports the following properties to provide access to the memory and control over allocations:
* - `SDL_PROP_IOSTREAM_DYNAMIC_MEMORY_POINTER`: a pointer to the internal memory of the stream. This can be set to NULL to transfer ownership of the memory to the application, which should free the memory with SDL_free(). If this is done, the next operation on the stream must be SDL_CloseIO().
* - `SDL_PROP_IOSTREAM_DYNAMIC_CHUNKSIZE_NUMBER`: memory will be allocated in multiples of this size, defaulting to 1024.
* This supports the following properties to provide access to the memory and
* control over allocations: - `SDL_PROP_IOSTREAM_DYNAMIC_MEMORY_POINTER`: a
* pointer to the internal memory of the stream. This can be set to NULL to
* transfer ownership of the memory to the application, which should free the
* memory with SDL_free(). If this is done, the next operation on the stream
* must be SDL_CloseIO(). - `SDL_PROP_IOSTREAM_DYNAMIC_CHUNKSIZE_NUMBER`:
* memory will be allocated in multiples of this size, defaulting to 1024.
*
* \returns a pointer to a new SDL_IOStream structure, or NULL if it fails;
* call SDL_GetError() for more information.