Changeset 1606 for trunk/psLib/src/sysUtils/psMemory.h

Timestamp:

Aug 23, 2004, 12:36:04 PM (22 years ago)

Author:

desonia

Message:

changed psImageSubset to subset an image without making a deep copy.

File:

• trunk/psLib/src/sysUtils/psMemory.h (modified) (2 diffs)

trunk/psLib/src/sysUtils/psMemory.h

@@ -12 +12 @@
  *  @ingroup MemoryManagement
  *
- *  @version $Revision: 1.28 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-08-10 01:55:34 $
+ *  @version $Revision: 1.29 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-08-23 22:36:03 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -135 +135 @@
                );
 
-void p_psMemSetDeallocator(void *ptr, psFreeFcn freeFcn);
-psFreeFcn p_psMemGetDeallocator(void *ptr);
-
 /// Memory allocation. psAlloc sends file and line number to p_psAlloc.
 #define psAlloc(size) p_psAlloc(size, __FILE__, __LINE__)
 #endif
+
+/** Set the deallocator routine
+ *
+ *  A deallocator routine can optionally be assigned to a memory block to 
+ *  ensure that associated memory blocks also get freed, e.g., memory buffers
+ *  referenced within a struct.
+ *
+ */
+void p_psMemSetDeallocator(
+    void *ptr,                         ///< the memory block to operate on
+    psFreeFcn freeFcn                  ///< the function to be executed at deallocation
+);
+
+/** Get the deallocator routine
+ *
+ *  This function returns the deallocator for a memory block.  A deallocator 
+ *  routine can optionally be assigned to a memory block to ensure that 
+ *  associated memory blocks also get freed, e.g., memory buffers referenced 
+ *  within a struct.  
+ *
+ *  @return psFreeFcn    the routine to be called at deallocation.
+ */
+psFreeFcn p_psMemGetDeallocator(
+    void *ptr                          ///< the memory block
+);
 
 /** Memory re-allocation.  This operates much like realloc(), but is guaranteed to return a non-NULL value.