Updated AllocatorI::realloc docs.

This commit is contained in:
Бранимир Караџић
2022-08-18 18:11:54 -07:00
parent b4046a0f13
commit 78fb3b4044

View File

@@ -47,13 +47,20 @@ namespace bx
///
virtual ~AllocatorI() = 0;
/// Allocates, resizes memory block, or frees memory.
/// Allocates, resizes, or frees memory block.
///
/// @param[in] _ptr If _ptr is NULL new block will be allocated.
/// @remark
/// - Allocate memory block: _ptr == NULL && size > 0
/// - Resize memory block: _ptr != NULL && size > 0
/// - Free memory block: _ptr != NULL && size == 0
///
/// @param[in] _ptr If _ptr is NULL new block will be allocated. If _ptr is not-NULL, and
/// _size is not 0, memory block will be resized.
/// @param[in] _size If _ptr is set, and _size is 0, memory will be freed.
/// @param[in] _align Alignment.
/// @param[in] _file Debug file path info.
/// @param[in] _line Debug file line info.
///
virtual void* realloc(
void* _ptr
, size_t _size