From 2bef5da2f3a3a5c3f1e667d5f50c2f28f6d96baf Mon Sep 17 00:00:00 2001 From: inmarket Date: Sat, 20 Jul 2013 21:57:01 +1000 Subject: Added gfxRealloc() --- include/gos/gos.h | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'include/gos/gos.h') diff --git a/include/gos/gos.h b/include/gos/gos.h index fe45ce60..84a2fd0a 100644 --- a/include/gos/gos.h +++ b/include/gos/gos.h @@ -127,6 +127,26 @@ */ void *gfxAlloc(size_t sz); + /** + * @brief Re-allocate memory + * @return A pointer to the new memory area or NULL if there is no more memory available + * + * @param[in] ptr The old memory area to be increased/decreased in size + * @param[in] oldsz The size in bytes of the old memory area + * @param[in] newsz The size in bytes of the new memory area + * + * @note Some operating systems don't use the oldsz parameter as they implicitly know the size of + * old memory area. The parameter must always be supplied however for API compatibility. + * @note gfxRealloc() can make the area smaller or larger but may have to return a different pointer. + * If this occurs the new area contains a copy of the data from the old area. The old memory + * pointer should not be used after this routine as the original area may have been freed. + * @note If there is insufficient memory to create the new memory region, NULL is returned and the + * old memory area is left unchanged. + * + * @api + */ + void *gfxRealloc(void *ptr, size_t oldsz, size_t newsz); + /** * @brief Free memory * -- cgit v1.2.3