Merge branch 'blender2.7'
[blender.git] / intern / memutil / MEM_RefCountedC-Api.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file memutil/MEM_RefCountedC-Api.h
21  *  \ingroup memutil
22  */
23
24 /**
25  * @file        MEM_RefCountedC-Api.h
26  * Interface for C access to functionality relating to shared objects in the foundation library.
27  */
28
29 #ifndef __MEM_REFCOUNTEDC_API_H__
30 #define __MEM_REFCOUNTEDC_API_H__
31
32 /** A pointer to a private object. */
33 typedef struct MEM_TOpaqueObject* MEM_TObjectPtr;
34 /** A pointer to a shared object. */
35 typedef MEM_TObjectPtr MEM_TRefCountedObjectPtr;
36
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42
43 /**
44  * Returns the reference count of this object.
45  * @param shared The object to query.
46  * @return The current reference count.
47  */
48 extern int      MEM_RefCountedGetRef(MEM_TRefCountedObjectPtr shared);
49
50 /**
51  * Increases the reference count of this object.
52  * @param shared The object to query.
53  * @return The new reference count.
54  */
55 extern int      MEM_RefCountedIncRef(MEM_TRefCountedObjectPtr shared);
56
57 /**
58  * Decreases the reference count of this object.
59  * If the reference count reaches zero, the object self-destructs.
60  * @param shared The object to query.
61  * @return The new reference count.
62  */
63 extern int      MEM_RefCountedDecRef(MEM_TRefCountedObjectPtr shared);
64
65
66 #ifdef __cplusplus
67 }
68 #endif
69
70 #endif // __MEM_REFCOUNTEDC_API_H__