Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenkernel / BKE_colorband.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 #ifndef __BKE_COLORBAND_H__
20 #define __BKE_COLORBAND_H__
21
22 /** \file */
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 struct ColorBand;
29
30 /*  in ColorBand struct */
31 #define MAXCOLORBAND 32
32
33 void              BKE_colorband_init(struct ColorBand *coba, bool rangetype);
34 void              BKE_colorband_init_from_table_rgba(
35         struct ColorBand *coba, const float (*array)[4], const int array_len, bool filter_sample);
36 struct ColorBand *BKE_colorband_add(bool rangetype);
37 bool              BKE_colorband_evaluate(const struct ColorBand *coba, float in, float out[4]);
38 void              BKE_colorband_evaluate_table_rgba(const struct ColorBand *coba, float **array, int *size);
39 struct CBData    *BKE_colorband_element_add(struct ColorBand *coba, float position);
40 int               BKE_colorband_element_remove(struct ColorBand *coba, int index);
41 void              BKE_colorband_update_sort(struct ColorBand *coba);
42
43 #ifdef __cplusplus
44 }
45 #endif
46
47 #endif /* __BKE_COLORBAND_H__ */