Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenkernel / BKE_texture.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_TEXTURE_H__
20 #define __BKE_TEXTURE_H__
21
22 /** \file \ingroup bke
23  */
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 struct Brush;
30 struct ColorBand;
31 struct FreestyleLineStyle;
32 struct ImagePool;
33 struct Lamp;
34 struct MTex;
35 struct Main;
36 struct Material;
37 struct ParticleSettings;
38 struct PointDensity;
39 struct Tex;
40 struct TexMapping;
41 struct TexResult;
42 struct World;
43 struct bNode;
44
45 /*  in ColorBand struct */
46 #define MAXCOLORBAND 32
47
48
49 void         BKE_texture_free(struct Tex *tex);
50 void         BKE_texture_default(struct Tex *tex);
51 void         BKE_texture_copy_data(struct Main *bmain, struct Tex *tex_dst, const struct Tex *tex_src, const int flag);
52 struct Tex  *BKE_texture_copy(struct Main *bmain, const struct Tex *tex);
53 struct Tex  *BKE_texture_add(struct Main *bmain, const char *name);
54 struct Tex  *BKE_texture_localize(struct Tex *tex);
55 void         BKE_texture_make_local(struct Main *bmain, struct Tex *tex, const bool lib_local);
56 void         BKE_texture_type_set(struct Tex *tex, int type);
57
58 void         BKE_texture_mtex_default(struct MTex *mtex);
59 struct MTex *BKE_texture_mtex_add(void);
60 struct MTex *BKE_texture_mtex_add_id(struct ID *id, int slot);
61 /* UNUSED */
62 // void autotexname(struct Tex *tex);
63
64 struct Tex *give_current_linestyle_texture(struct FreestyleLineStyle *linestyle);
65 struct Tex *give_current_brush_texture(struct Brush *br);
66 struct Tex *give_current_particle_texture(struct ParticleSettings *part);
67
68 bool give_active_mtex(struct ID *id, struct MTex ***mtex_ar, short *act);
69 void set_active_mtex(struct ID *id, short act);
70
71 void set_current_brush_texture(struct Brush *br, struct Tex *tex);
72 void set_current_linestyle_texture(struct FreestyleLineStyle *linestyle, struct Tex *tex);
73 void set_current_particle_texture(struct ParticleSettings *part, struct Tex *tex);
74
75 struct TexMapping *BKE_texture_mapping_add(int type);
76 void               BKE_texture_mapping_default(struct TexMapping *texmap, int type);
77 void               BKE_texture_mapping_init(struct TexMapping *texmap);
78
79 struct ColorMapping *BKE_texture_colormapping_add(void);
80 void                 BKE_texture_colormapping_default(struct ColorMapping *colormap);
81
82 void                 BKE_texture_pointdensity_init_data(struct PointDensity *pd);
83 void                 BKE_texture_pointdensity_free_data(struct PointDensity *pd);
84 void                 BKE_texture_pointdensity_free(struct PointDensity *pd);
85 struct PointDensity *BKE_texture_pointdensity_add(void);
86 struct PointDensity *BKE_texture_pointdensity_copy(const struct PointDensity *pd, const int flag);
87
88 bool    BKE_texture_dependsOnTime(const struct Tex *texture);
89 bool    BKE_texture_is_image_user(const struct Tex *tex);
90
91 void BKE_texture_get_value_ex(
92         const struct Scene *scene, struct Tex *texture,
93         float *tex_co, struct TexResult *texres,
94         struct ImagePool *pool,
95         bool use_color_management);
96
97 void BKE_texture_get_value(
98         const struct Scene *scene, struct Tex *texture,
99         float *tex_co, struct TexResult *texres, bool use_color_management);
100
101 void BKE_texture_fetch_images_for_pool(struct Tex *texture, struct ImagePool *pool);
102
103 #ifdef __cplusplus
104 }
105 #endif
106
107 #endif