Refactor/enhance BKE_material_make_local() and BKE_image_make_local().
[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 FreestyleLineStyle;
45 struct Lamp;
46 struct Main;
47 struct Material;
48 struct MTex;
49 struct OceanTex;
50 struct ParticleSettings;
51 struct PointDensity;
52 struct Tex;
53 struct TexMapping;
54 struct TexResult;
55 struct VoxelData;
56 struct World;
57
58 /*  in ColorBand struct */
59 #define MAXCOLORBAND 32
60
61
62 void init_colorband(struct ColorBand *coba, bool rangetype);
63 struct ColorBand *add_colorband(bool rangetype);
64 bool do_colorband(const struct ColorBand *coba, float in, float out[4]);
65 void colorband_table_RGBA(struct ColorBand *coba, float **array, int *size);
66 struct CBData *colorband_element_add(struct ColorBand *coba, float position);
67 int colorband_element_remove(struct ColorBand *coba, int index);
68 void colorband_update_sort(struct ColorBand *coba);
69
70 void         BKE_texture_free(struct Tex *tex);
71 void         BKE_texture_default(struct Tex *tex);
72 struct Tex  *BKE_texture_copy(struct Main *bmain, struct Tex *tex);
73 struct Tex  *BKE_texture_add(struct Main *bmain, const char *name);
74 struct Tex  *BKE_texture_localize(struct Tex *tex);
75 void         BKE_texture_make_local(struct Main *bmain, struct Tex *tex);
76 void         BKE_texture_type_set(struct Tex *tex, int type);
77
78 void         BKE_texture_mtex_default(struct MTex *mtex);
79 struct MTex *BKE_texture_mtex_add(void);
80 struct MTex *BKE_texture_mtex_add_id(struct ID *id, int slot);
81 /* UNUSED */
82 // void autotexname(struct Tex *tex);
83
84 struct Tex *give_current_object_texture(struct Object *ob);
85 struct Tex *give_current_material_texture(struct Material *ma);
86 struct Tex *give_current_lamp_texture(struct Lamp *la);
87 struct Tex *give_current_linestyle_texture(struct FreestyleLineStyle *linestyle);
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 bool 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_linestyle_texture(struct FreestyleLineStyle *linestyle, struct Tex *tex);
102 void set_current_particle_texture(struct ParticleSettings *part, struct Tex *tex);
103
104 bool has_current_material_texture(struct Material *ma);
105
106 struct TexMapping *BKE_texture_mapping_add(int type);
107 void               BKE_texture_mapping_default(struct TexMapping *texmap, int type);
108 void               BKE_texture_mapping_init(struct TexMapping *texmap);
109
110 struct ColorMapping *BKE_texture_colormapping_add(void);
111 void                 BKE_texture_colormapping_default(struct ColorMapping *colormap);
112
113 void           BKE_texture_envmap_free_data(struct EnvMap *env);
114 void           BKE_texture_envmap_free(struct EnvMap *env);
115 struct EnvMap *BKE_texture_envmap_add(void);
116 struct EnvMap *BKE_texture_envmap_copy(struct EnvMap *env);
117
118 void                 BKE_texture_pointdensity_init_data(struct PointDensity *pd);
119 void                 BKE_texture_pointdensity_free_data(struct PointDensity *pd);
120 void                 BKE_texture_pointdensity_free(struct PointDensity *pd);
121 struct PointDensity *BKE_texture_pointdensity_add(void);
122 struct PointDensity *BKE_texture_pointdensity_copy(struct PointDensity *pd);
123
124 void              BKE_texture_voxeldata_free_data(struct VoxelData *vd);
125 void              BKE_texture_voxeldata_free(struct VoxelData *vd);
126 struct VoxelData *BKE_texture_voxeldata_add(void);
127 struct VoxelData *BKE_texture_voxeldata_copy(struct VoxelData *vd);
128
129 void             BKE_texture_ocean_free(struct OceanTex *ot);
130 struct OceanTex *BKE_texture_ocean_add(void);
131 struct OceanTex *BKE_texture_ocean_copy(struct OceanTex *ot);
132
133 bool    BKE_texture_dependsOnTime(const struct Tex *texture);
134 bool    BKE_texture_is_image_user(const struct Tex *tex);
135
136 void BKE_texture_get_value(
137         const struct Scene *scene, struct Tex *texture,
138         float *tex_co, struct TexResult *texres, bool use_color_management);
139
140 #ifdef __cplusplus
141 }
142 #endif
143
144 #endif
145