Merge branch 'blender2.7'
[blender.git] / intern / memutil / MEM_RefCountedC-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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file memutil/MEM_RefCountedC-Api.h
29  *  \ingroup memutil
30  */
31
32 /**
33  * @file        MEM_RefCountedC-Api.h
34  * Interface for C access to functionality relating to shared objects in the foundation library.
35  */
36
37 #ifndef __MEM_REFCOUNTEDC_API_H__
38 #define __MEM_REFCOUNTEDC_API_H__
39
40 /** A pointer to a private object. */
41 typedef struct MEM_TOpaqueObject* MEM_TObjectPtr;
42 /** A pointer to a shared object. */
43 typedef MEM_TObjectPtr MEM_TRefCountedObjectPtr;
44
45
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49
50
51 /**
52  * Returns the reference count of this object.
53  * @param shared The object to query.
54  * @return The current reference count.
55  */
56 extern int      MEM_RefCountedGetRef(MEM_TRefCountedObjectPtr shared);
57
58 /**
59  * Increases the reference count of this object.
60  * @param shared The object to query.
61  * @return The new reference count.
62  */
63 extern int      MEM_RefCountedIncRef(MEM_TRefCountedObjectPtr shared);
64
65 /**
66  * Decreases the reference count of this object.
67  * If the reference count reaches zero, the object self-destructs.
68  * @param shared The object to query.
69  * @return The new reference count.
70  */
71 extern int      MEM_RefCountedDecRef(MEM_TRefCountedObjectPtr shared);
72
73
74 #ifdef __cplusplus
75 }
76 #endif
77
78 #endif // __MEM_REFCOUNTEDC_API_H__