From fc26d5d3285d4a5f501c7416a61181e3402d4a50 Mon Sep 17 00:00:00 2001 From: SDL Wiki Bot Date: Mon, 18 Mar 2024 04:28:30 +0000 Subject: [PATCH] Sync SDL3 wiki -> header --- include/SDL3/SDL_iostream.h | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/include/SDL3/SDL_iostream.h b/include/SDL3/SDL_iostream.h index 856f3ff2f3..cdffa2b6c6 100644 --- a/include/SDL3/SDL_iostream.h +++ b/include/SDL3/SDL_iostream.h @@ -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.