Cycles: svn merge -r41225:41232 ^/trunk/blender
[blender.git] / intern / memutil / MEM_CacheLimiterC-Api.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Peter Schlaile <peter@schlaile.de> 2005
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file memutil/MEM_CacheLimiterC-Api.h
24  *  \ingroup memutil
25  */
26
27
28 #ifndef MEM_CACHELIMITERC_API_H
29 #define MEM_CACHELIMITERC_API_H
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34         
35 struct MEM_CacheLimiter_s;
36 struct MEM_CacheLimiterHandle_s;
37
38 typedef struct MEM_CacheLimiter_s MEM_CacheLimiterC;
39 typedef struct MEM_CacheLimiterHandle_s MEM_CacheLimiterHandleC;
40
41 /* function used to remove data from memory */
42 typedef void(*MEM_CacheLimiter_Destruct_Func)(void*);
43
44 #ifndef MEM_CACHELIMITER_H
45 extern void MEM_CacheLimiter_set_maximum(int m);
46 extern int MEM_CacheLimiter_get_maximum(void);
47 #endif // MEM_CACHELIMITER_H
48 /** 
49  * Create new MEM_CacheLimiter object 
50  * managed objects are destructed with the data_destructor
51  *
52  * @param data_destructor
53  * @return A new MEM_CacheLimter object
54  */
55
56 extern MEM_CacheLimiterC * new_MEM_CacheLimiter(
57         MEM_CacheLimiter_Destruct_Func data_destructor);
58
59 /** 
60  * Delete MEM_CacheLimiter
61  * 
62  * Frees the memory of the CacheLimiter but does not touch managed objects!
63  *
64  * @param This "This" pointer
65  */
66
67 extern void delete_MEM_CacheLimiter(MEM_CacheLimiterC * This);
68
69 /** 
70  * Manage object
71  * 
72  * @param This "This" pointer, data data object to manage
73  * @return CacheLimiterHandle to ref, unref, touch the managed object
74  */
75         
76 extern MEM_CacheLimiterHandleC * MEM_CacheLimiter_insert(
77         MEM_CacheLimiterC * This, void * data);
78
79 /** 
80  * Free objects until memory constraints are satisfied
81  * 
82  * @param This "This" pointer
83  */
84
85 extern void MEM_CacheLimiter_enforce_limits(MEM_CacheLimiterC * This);
86
87 /** 
88  * Unmanage object previously inserted object. 
89  * Does _not_ delete managed object!
90  * 
91  * @param This "This" pointer, handle of object
92  */
93         
94 extern void MEM_CacheLimiter_unmanage(MEM_CacheLimiterHandleC * handle);
95
96
97 /** 
98  * Raise priority of object (put it at the tail of the deletion chain)
99  * 
100  * @param handle of object
101  */
102         
103 extern void MEM_CacheLimiter_touch(MEM_CacheLimiterHandleC * handle);
104
105 /** 
106  * Increment reference counter. Objects with reference counter != 0 are _not_
107  * deleted.
108  * 
109  * @param handle of object
110  */
111         
112 extern void MEM_CacheLimiter_ref(MEM_CacheLimiterHandleC * handle);
113
114 /** 
115  * Decrement reference counter. Objects with reference counter != 0 are _not_
116  * deleted.
117  * 
118  * @param handle of object
119  */
120         
121 extern void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC * handle);
122
123 /** 
124  * Get reference counter.
125  * 
126  * @param This "This" pointer, handle of object
127  */
128         
129 extern int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC * handle);
130
131 /** 
132  * Get pointer to managed object
133  * 
134  * @param handle of object
135  */
136         
137 extern void * MEM_CacheLimiter_get(MEM_CacheLimiterHandleC * handle);
138
139 #ifdef __cplusplus
140 }
141 #endif
142
143
144 #endif // MEM_CACHELIMITERC_API_H