Code cleanup: use r_ prefix for return args
[blender.git] / source / blender / blenkernel / BKE_texture.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 #ifndef __BKE_TEXTURE_H__
28 #define __BKE_TEXTURE_H__
29
30 /** \file BKE_texture.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  */
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct bNode;
41 struct Brush;
42 struct ColorBand;
43 struct EnvMap;
44 struct HaloRen;
45 struct Lamp;
46 struct LampRen;
47 struct Main;
48 struct Material;
49 struct MTex;
50 struct OceanTex;
51 struct ParticleSettings;
52 struct PointDensity;
53 struct Tex;
54 struct TexMapping;
55 struct TexResult;
56 struct VoxelData;
57 struct World;
58
59 /*  in ColorBand struct */
60 #define MAXCOLORBAND 32
61
62
63 void BKE_texture_free(struct Tex *t); 
64
65 void init_colorband(struct ColorBand *coba, bool rangetype);
66 struct ColorBand *add_colorband(bool rangetype);
67 bool do_colorband(const struct ColorBand *coba, float in, float out[4]);
68 void colorband_table_RGBA(struct ColorBand *coba, float **array, int *size);
69 struct CBData *colorband_element_add(struct ColorBand *coba, float position);
70 int colorband_element_remove(struct ColorBand *coba, int index);
71 void colorband_update_sort(struct ColorBand *coba);
72
73 void default_tex(struct Tex *tex);
74 struct Tex *add_texture(struct Main *bmain, const char *name);
75 void tex_set_type(struct Tex *tex, int type);
76 void default_mtex(struct MTex *mtex);
77 struct MTex *add_mtex(void);
78 struct MTex *add_mtex_id(struct ID *id, int slot);
79 struct Tex *BKE_texture_copy(struct Tex *tex);
80 struct Tex *localize_texture(struct Tex *tex);
81 void BKE_texture_make_local(struct Tex *tex);
82 /* UNUSED */
83 // void autotexname(struct Tex *tex);
84
85 struct Tex *give_current_object_texture(struct Object *ob);
86 struct Tex *give_current_material_texture(struct Material *ma);
87 struct Tex *give_current_lamp_texture(struct Lamp *la);
88 struct Tex *give_current_world_texture(struct World *world);
89 struct Tex *give_current_brush_texture(struct Brush *br);
90 struct Tex *give_current_particle_texture(struct ParticleSettings *part);
91
92 struct bNode *give_current_material_texture_node(struct Material *ma);
93
94 int  give_active_mtex(struct ID *id, struct MTex ***mtex_ar, short *act);
95 void set_active_mtex(struct ID *id, short act);
96
97 void set_current_brush_texture(struct Brush *br, struct Tex *tex);
98 void set_current_world_texture(struct World *wo, struct Tex *tex);
99 void set_current_material_texture(struct Material *ma, struct Tex *tex);
100 void set_current_lamp_texture(struct Lamp *la, struct Tex *tex);
101 void set_current_particle_texture(struct ParticleSettings *part, struct Tex *tex);
102
103 bool has_current_material_texture(struct Material *ma);
104
105 struct TexMapping *add_tex_mapping(int type);
106 void default_tex_mapping(struct TexMapping *texmap, int type);
107 void init_tex_mapping(struct TexMapping *texmap);
108
109 struct ColorMapping *add_color_mapping(void);
110 void default_color_mapping(struct ColorMapping *colormap);
111
112 void    BKE_free_envmapdata(struct EnvMap *env);
113 void    BKE_free_envmap(struct EnvMap *env);
114 struct EnvMap *BKE_add_envmap(void);
115 struct EnvMap *BKE_copy_envmap(struct EnvMap *env);
116
117 void    BKE_free_pointdensitydata(struct PointDensity *pd);
118 void    BKE_free_pointdensity(struct PointDensity *pd);
119 struct PointDensity *BKE_add_pointdensity(void);
120 struct PointDensity *BKE_copy_pointdensity(struct PointDensity *pd);
121
122 void BKE_free_voxeldatadata(struct VoxelData *vd);
123 void BKE_free_voxeldata(struct VoxelData *vd);
124 struct VoxelData *BKE_add_voxeldata(void);
125 struct VoxelData *BKE_copy_voxeldata(struct VoxelData *vd);
126
127 void BKE_free_oceantex(struct OceanTex *ot);
128 struct OceanTex *BKE_add_oceantex(void);
129 struct OceanTex *BKE_copy_oceantex(struct OceanTex *ot);
130         
131 bool    BKE_texture_dependsOnTime(const struct Tex *texture);
132
133 void BKE_texture_get_value(struct Scene *scene, struct Tex *texture, float *tex_co, struct TexResult *texres, bool use_color_management);
134
135 #ifdef __cplusplus
136 }
137 #endif
138
139 #endif
140