Revert "Fix T67040: Undo crashes after renaming"
[blender.git] / source / blender / gpu / GPU_material.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) 2005 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup gpu
22  */
23
24 #ifndef __GPU_MATERIAL_H__
25 #define __GPU_MATERIAL_H__
26
27 #include "DNA_customdata_types.h" /* for CustomDataType */
28 #include "DNA_listBase.h"
29
30 #include "BLI_sys_types.h" /* for bool */
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 struct GPUMaterial;
37 struct GPUNode;
38 struct GPUNodeLink;
39 struct GPUNodeStack;
40 struct GPUTexture;
41 struct GPUUniformBuffer;
42 struct GPUVertAttrLayers;
43 struct Image;
44 struct ImageUser;
45 struct ListBase;
46 struct Main;
47 struct Material;
48 struct Object;
49 struct PreviewImage;
50 struct Scene;
51 struct World;
52 struct bNode;
53 struct bNodeTree;
54
55 typedef struct GPUMaterial GPUMaterial;
56 typedef struct GPUNode GPUNode;
57 typedef struct GPUNodeLink GPUNodeLink;
58
59 typedef struct GPUParticleInfo GPUParticleInfo;
60
61 /* Functions to create GPU Materials nodes */
62
63 typedef enum eGPUType {
64   /* Keep in sync with GPU_DATATYPE_STR */
65   /* The value indicates the number of elements in each type */
66   GPU_NONE = 0,
67   GPU_FLOAT = 1,
68   GPU_VEC2 = 2,
69   GPU_VEC3 = 3,
70   GPU_VEC4 = 4,
71   GPU_MAT3 = 9,
72   GPU_MAT4 = 16,
73
74   /* Values not in GPU_DATATYPE_STR */
75   GPU_TEX1D_ARRAY = 1001,
76   GPU_TEX2D = 1002,
77   GPU_TEX3D = 1003,
78   GPU_SHADOW2D = 1004,
79   GPU_TEXCUBE = 1005,
80
81   /* GLSL Struct types */
82   GPU_CLOSURE = 1006,
83
84   /* Opengl Attributes */
85   GPU_ATTR = 3001,
86 } eGPUType;
87
88 typedef enum eGPUBuiltin {
89   GPU_VIEW_MATRIX = (1 << 0),
90   GPU_OBJECT_MATRIX = (1 << 1),
91   GPU_INVERSE_VIEW_MATRIX = (1 << 2),
92   GPU_INVERSE_OBJECT_MATRIX = (1 << 3),
93   GPU_VIEW_POSITION = (1 << 4),
94   GPU_VIEW_NORMAL = (1 << 5),
95   GPU_OBCOLOR = (1 << 6),
96   GPU_AUTO_BUMPSCALE = (1 << 7),
97   GPU_CAMERA_TEXCO_FACTORS = (1 << 8),
98   GPU_PARTICLE_SCALAR_PROPS = (1 << 9),
99   GPU_PARTICLE_LOCATION = (1 << 10),
100   GPU_PARTICLE_VELOCITY = (1 << 11),
101   GPU_PARTICLE_ANG_VELOCITY = (1 << 12),
102   GPU_LOC_TO_VIEW_MATRIX = (1 << 13),
103   GPU_INVERSE_LOC_TO_VIEW_MATRIX = (1 << 14),
104   GPU_OBJECT_INFO = (1 << 15),
105   GPU_VOLUME_DENSITY = (1 << 16),
106   GPU_VOLUME_FLAME = (1 << 17),
107   GPU_VOLUME_TEMPERATURE = (1 << 18),
108   GPU_BARYCENTRIC_TEXCO = (1 << 19),
109   GPU_BARYCENTRIC_DIST = (1 << 20),
110   GPU_WORLD_NORMAL = (1 << 21),
111 } eGPUBuiltin;
112
113 typedef enum eGPUMatFlag {
114   GPU_MATFLAG_DIFFUSE = (1 << 0),
115   GPU_MATFLAG_GLOSSY = (1 << 1),
116   GPU_MATFLAG_REFRACT = (1 << 2),
117   GPU_MATFLAG_SSS = (1 << 3),
118 } eGPUMatFlag;
119
120 typedef enum eGPUBlendMode {
121   GPU_BLEND_SOLID = 0,
122   GPU_BLEND_ADD = 1,
123   GPU_BLEND_ALPHA = 2,
124   GPU_BLEND_CLIP = 4,
125   GPU_BLEND_ALPHA_SORT = 8,
126   GPU_BLEND_ALPHA_TO_COVERAGE = 16,
127 } eGPUBlendMode;
128
129 typedef struct GPUNodeStack {
130   eGPUType type;
131   float vec[4];
132   struct GPUNodeLink *link;
133   bool hasinput;
134   bool hasoutput;
135   short sockettype;
136   bool end;
137 } GPUNodeStack;
138
139 typedef enum eGPUMaterialStatus {
140   GPU_MAT_FAILED = 0,
141   GPU_MAT_QUEUED,
142   GPU_MAT_SUCCESS,
143 } eGPUMaterialStatus;
144
145 GPUNodeLink *GPU_attribute(CustomDataType type, const char *name);
146 GPUNodeLink *GPU_constant(float *num);
147 GPUNodeLink *GPU_uniform(float *num);
148 GPUNodeLink *GPU_image(struct Image *ima, struct ImageUser *iuser);
149 GPUNodeLink *GPU_color_band(GPUMaterial *mat, int size, float *pixels, float *layer);
150 GPUNodeLink *GPU_builtin(eGPUBuiltin builtin);
151
152 bool GPU_link(GPUMaterial *mat, const char *name, ...);
153 bool GPU_stack_link(GPUMaterial *mat,
154                     struct bNode *node,
155                     const char *name,
156                     GPUNodeStack *in,
157                     GPUNodeStack *out,
158                     ...);
159 GPUNodeLink *GPU_uniformbuffer_link_out(struct GPUMaterial *mat,
160                                         struct bNode *node,
161                                         struct GPUNodeStack *stack,
162                                         const int index);
163
164 void GPU_material_output_link(GPUMaterial *material, GPUNodeLink *link);
165 eGPUBuiltin GPU_get_material_builtins(GPUMaterial *material);
166
167 void GPU_material_sss_profile_create(GPUMaterial *material,
168                                      float radii[3],
169                                      short *falloff_type,
170                                      float *sharpness);
171 struct GPUUniformBuffer *GPU_material_sss_profile_get(GPUMaterial *material,
172                                                       int sample_len,
173                                                       struct GPUTexture **tex_profile);
174
175 /* High level functions to create and use GPU materials */
176 GPUMaterial *GPU_material_from_nodetree_find(struct ListBase *gpumaterials,
177                                              const void *engine_type,
178                                              int options);
179 GPUMaterial *GPU_material_from_nodetree(struct Scene *scene,
180                                         struct Material *ma,
181                                         struct bNodeTree *ntree,
182                                         struct ListBase *gpumaterials,
183                                         const void *engine_type,
184                                         int options,
185                                         const char *vert_code,
186                                         const char *geom_code,
187                                         const char *frag_lib,
188                                         const char *defines,
189                                         const char *name);
190 void GPU_material_compile(GPUMaterial *mat);
191 void GPU_material_free(struct ListBase *gpumaterial);
192
193 void GPU_materials_free(struct Main *bmain);
194
195 struct Scene *GPU_material_scene(GPUMaterial *material);
196 struct GPUPass *GPU_material_get_pass(GPUMaterial *material);
197 struct ListBase *GPU_material_get_inputs(GPUMaterial *material);
198 struct Material *GPU_material_get_material(GPUMaterial *material);
199 eGPUMaterialStatus GPU_material_status(GPUMaterial *mat);
200
201 struct GPUUniformBuffer *GPU_material_uniform_buffer_get(GPUMaterial *material);
202 void GPU_material_uniform_buffer_create(GPUMaterial *material, ListBase *inputs);
203 struct GPUUniformBuffer *GPU_material_create_sss_profile_ubo(void);
204
205 void GPU_material_vertex_attrs(GPUMaterial *material, struct GPUVertAttrLayers *attrs);
206
207 bool GPU_material_use_domain_surface(GPUMaterial *mat);
208 bool GPU_material_use_domain_volume(GPUMaterial *mat);
209
210 void GPU_material_flag_set(GPUMaterial *mat, eGPUMatFlag flag);
211 bool GPU_material_flag_get(GPUMaterial *mat, eGPUMatFlag flag);
212
213 void GPU_pass_cache_init(void);
214 void GPU_pass_cache_garbage_collect(void);
215 void GPU_pass_cache_free(void);
216
217 #ifdef __cplusplus
218 }
219 #endif
220
221 #endif /*__GPU_MATERIAL_H__*/