From eb8244c5585eb583cdfaa3b8319a2d1aae46f226 Mon Sep 17 00:00:00 2001 From: Brandon Jones Date: Tue, 25 Oct 2022 11:33:27 -0700 Subject: [PATCH] Document MVI MemoryAllocation Lifetime --- src/mvi/gpgmm.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/mvi/gpgmm.h b/src/mvi/gpgmm.h index d6379e107..32994b6cd 100644 --- a/src/mvi/gpgmm.h +++ b/src/mvi/gpgmm.h @@ -45,6 +45,9 @@ namespace gpgmm { MemoryAllocatorStats mStats = {}; }; + // MemoryAllocation represents a range of memory. A MemoryAllocation object will be held alive + // until MemoryAllocator::DeallocateMemory is called on the MemoryAllocator object from which it + // was originally created. class MemoryAllocation { public: MemoryAllocation(MemoryAllocator* allocator, MemoryBase* memory);