Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenkernel / BKE_lamp.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 #ifndef __BKE_LAMP_H__
21 #define __BKE_LAMP_H__
22
23 /** \file \ingroup bke
24  *  \brief General operations, lookup, etc. for blender lamps.
25  */
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 #include "BLI_compiler_attrs.h"
31
32 struct Lamp;
33 struct Main;
34 struct Scene;
35
36 void BKE_lamp_init(struct Lamp *la);
37 struct Lamp *BKE_lamp_add(struct Main *bmain, const char *name) ATTR_WARN_UNUSED_RESULT;
38 void BKE_lamp_copy_data(struct Main *bmain, struct Lamp *la_dst, const struct Lamp *la_src, const int flag);
39 struct Lamp *BKE_lamp_copy(struct Main *bmain, const struct Lamp *la) ATTR_WARN_UNUSED_RESULT;
40 struct Lamp *BKE_lamp_localize(struct Lamp *la) ATTR_WARN_UNUSED_RESULT;
41 void BKE_lamp_make_local(struct Main *bmain, struct Lamp *la, const bool lib_local);
42 void BKE_lamp_free(struct Lamp *la);
43
44 #ifdef __cplusplus
45 }
46 #endif
47
48 #endif