Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / memutil / MEM_CacheLimiterC-Api.h
index 1ae5e9d..479bacd 100644 (file)
@@ -1,6 +1,4 @@
 /*
- * ***** BEGIN GPL LICENSE BLOCK *****
- *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- *
- * Contributor(s): Peter Schlaile <peter@schlaile.de> 2005
- *
- * ***** END GPL LICENSE BLOCK *****
  */
 
-/** \file memutil/MEM_CacheLimiterC-Api.h
- *  \ingroup memutil
+/** \file \ingroup memutil
  */
 
 
@@ -47,17 +40,22 @@ typedef size_t (*MEM_CacheLimiter_DataSize_Func) (void*);
 /* function used to measure priority of item when freeing memory */
 typedef int (*MEM_CacheLimiter_ItemPriority_Func) (void*, int);
 
+/* function to check whether item could be destroyed */
+typedef bool (*MEM_CacheLimiter_ItemDestroyable_Func) (void*);
+
 #ifndef __MEM_CACHELIMITER_H__
 void MEM_CacheLimiter_set_maximum(size_t m);
-int MEM_CacheLimiter_get_maximum(void);
+size_t MEM_CacheLimiter_get_maximum(void);
+void MEM_CacheLimiter_set_disabled(bool disabled);
+bool MEM_CacheLimiter_is_disabled(void);
 #endif /* __MEM_CACHELIMITER_H__ */
 
 /**
  * Create new MEM_CacheLimiter object
  * managed objects are destructed with the data_destructor
  *
- * @param data_destructor
- * @return A new MEM_CacheLimter object
+ * \param data_destructor
+ * \return A new MEM_CacheLimter object
  */
 
 MEM_CacheLimiterC *new_MEM_CacheLimiter(MEM_CacheLimiter_Destruct_Func data_destructor,
@@ -68,7 +66,7 @@ MEM_CacheLimiterC *new_MEM_CacheLimiter(MEM_CacheLimiter_Destruct_Func data_dest
  *
  * Frees the memory of the CacheLimiter but does not touch managed objects!
  *
- * @param This "This" pointer
+ * \param This "This" pointer
  */
 
 void delete_MEM_CacheLimiter(MEM_CacheLimiterC *This);
@@ -76,16 +74,16 @@ void delete_MEM_CacheLimiter(MEM_CacheLimiterC *This);
 /**
  * Manage object
  *
- * @param This "This" pointer, data data object to manage
- * @return CacheLimiterHandle to ref, unref, touch the managed object
+ * \param This "This" pointer, data data object to manage
+ * \return CacheLimiterHandle to ref, unref, touch the managed object
  */
 
-MEM_CacheLimiterHandleC *MEM_CacheLimiter_insert(MEM_CacheLimiterC * This, void * data);
+MEM_CacheLimiterHandleC *MEM_CacheLimiter_insert(MEM_CacheLimiterC *This, void *data);
 
 /**
  * Free objects until memory constraints are satisfied
  *
- * @param This "This" pointer
+ * \param This "This" pointer
  */
 
 void MEM_CacheLimiter_enforce_limits(MEM_CacheLimiterC *This);
@@ -94,7 +92,7 @@ void MEM_CacheLimiter_enforce_limits(MEM_CacheLimiterC *This);
  * Unmanage object previously inserted object.
  * Does _not_ delete managed object!
  *
- * @param This "This" pointer, handle of object
+ * \param handle of object
  */
 
 void MEM_CacheLimiter_unmanage(MEM_CacheLimiterHandleC *handle);
@@ -103,7 +101,7 @@ void MEM_CacheLimiter_unmanage(MEM_CacheLimiterHandleC *handle);
 /**
  * Raise priority of object (put it at the tail of the deletion chain)
  *
- * @param handle of object
+ * \param handle of object
  */
 
 void MEM_CacheLimiter_touch(MEM_CacheLimiterHandleC *handle);
@@ -112,7 +110,7 @@ void MEM_CacheLimiter_touch(MEM_CacheLimiterHandleC *handle);
  * Increment reference counter. Objects with reference counter != 0 are _not_
  * deleted.
  *
- * @param handle of object
+ * \param handle of object
  */
 
 void MEM_CacheLimiter_ref(MEM_CacheLimiterHandleC *handle);
@@ -121,7 +119,7 @@ void MEM_CacheLimiter_ref(MEM_CacheLimiterHandleC *handle);
  * Decrement reference counter. Objects with reference counter != 0 are _not_
  * deleted.
  *
- * @param handle of object
+ * \param handle of object
  */
 
 void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC *handle);
@@ -129,7 +127,7 @@ void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC *handle);
 /**
  * Get reference counter.
  *
- * @param This "This" pointer, handle of object
+ * \param handle of object
  */
 
 int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC *handle);
@@ -137,14 +135,19 @@ int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC *handle);
 /**
  * Get pointer to managed object
  *
- * @param handle of object
+ * \param handle of object
  */
 
-void * MEM_CacheLimiter_get(MEM_CacheLimiterHandleC *handle);
+void *MEM_CacheLimiter_get(MEM_CacheLimiterHandleC *handle);
 
 void MEM_CacheLimiter_ItemPriority_Func_set(MEM_CacheLimiterC *This,
                                             MEM_CacheLimiter_ItemPriority_Func item_priority_func);
 
+void MEM_CacheLimiter_ItemDestroyable_Func_set(MEM_CacheLimiterC *This,
+                                               MEM_CacheLimiter_ItemDestroyable_Func item_destroyable_func);
+
+size_t MEM_CacheLimiter_get_memory_in_use(MEM_CacheLimiterC *This);
+
 #ifdef __cplusplus
 }
 #endif