Clay Engine: Mode engine templates.
[blender.git] / source / blender / draw / modes / particle_mode.c
1 /*
2  * Copyright 2016, Blender Foundation.
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  * Contributor(s): Blender Institute
19  *
20  */
21
22 /** \file blender/draw/modes/particle_mode.c
23  *  \ingroup draw
24  */
25
26 #include "DRW_engine.h"
27 #include "DRW_render.h"
28
29 /* If builtin shaders are needed */
30 #include "GPU_shader.h"
31
32 #include "draw_common.h"
33
34 #include "draw_mode_engines.h"
35
36 /* *********** LISTS *********** */
37 /* All lists are per viewport specific datas.
38  * They are all free when viewport changes engines
39  * or is free itself. Use PARTICLE_engine_init() to
40  * initialize most of them and PARTICLE_cache_init()
41  * for PARTICLE_PassList */
42
43 /* keep it under MAX_PASSES */
44 typedef struct PARTICLE_PassList {
45         /* Declare all passes here and init them in
46          * PARTICLE_cache_init().
47          * Only contains (DRWPass *) */
48         struct DRWPass *pass;
49 } PARTICLE_PassList;
50
51 /* keep it under MAX_BUFFERS */
52 typedef struct PARTICLE_FramebufferList {
53         /* Contains all framebuffer objects needed by this engine.
54          * Only contains (GPUFrameBuffer *) */
55         // struct GPUFrameBuffer *fb;
56 } PARTICLE_FramebufferList;
57
58 /* keep it under MAX_TEXTURES */
59 typedef struct PARTICLE_TextureList {
60         /* Contains all framebuffer textures / utility textures
61          * needed by this engine. Only viewport specific textures
62          * (not per object). Only contains (GPUTexture *) */
63         // struct GPUTexture *texture;
64 } PARTICLE_TextureList;
65
66 /* keep it under MAX_STORAGE */
67 typedef struct PARTICLE_StorageList {
68         /* Contains any other memory block that the engine needs.
69          * Only directly MEM_(m/c)allocN'ed blocks because they are
70          * free with MEM_freeN() when viewport is freed.
71          * (not per object) */
72         // struct CustomStruct *block;
73 } PARTICLE_StorageList;
74
75 typedef struct PARTICLE_Data {
76         /* Struct returned by DRW_viewport_engine_data_get.
77          * If you don't use one of these, just make it a (void *) */
78         // void *fbl;
79         char engine_name[32]; /* Required */
80         PARTICLE_FramebufferList *fbl;
81         PARTICLE_TextureList *txl;
82         PARTICLE_PassList *psl;
83         PARTICLE_StorageList *stl;
84 } PARTICLE_Data;
85
86 /* *********** STATIC *********** */
87
88 /* This keeps the references of the shading groups for
89  * easy access in PARTICLE_cache_populate() */
90 static DRWShadingGroup *group;
91
92 /* If needed, contains all global/Theme colors
93  * Add needed theme colors / values to DRW_globals_update() and update UBO
94  * Not needed for constant color. */
95 extern struct GPUUniformBuffer *globals_ubo; /* draw_common.c */
96 extern struct GlobalsUboStorage ts; /* draw_common.c */
97
98 /* Custom shaders :
99  * Add sources to source/blender/draw/modes/shaders
100  * init in PARTICLE_engine_init();
101  * free in PARTICLE_engine_free(); */
102 static struct GPUShader *custom_shader = NULL;
103
104 /* This keeps the reference of the viewport engine data because
105  * DRW_viewport_engine_data_get is slow and we don't want to
106  * call it for every object */
107 static PARTICLE_Data *vedata;
108
109 /* *********** FUNCTIONS *********** */
110
111 /* Init Textures, Framebuffers, Storage and Shaders.
112  * It is called for every frames.
113  * (Optionnal) */
114 static void PARTICLE_engine_init(void)
115 {
116         PARTICLE_Data *vedata = DRW_viewport_engine_data_get("ParticleMode");
117         PARTICLE_TextureList *txl = vedata->txl;
118         PARTICLE_FramebufferList *fbl = vedata->fbl;
119         PARTICLE_StorageList *stl = vedata->stl;
120
121         /* Init Framebuffers like this: order is attachment order (for color texs) */
122         /*
123          * DRWFboTexture tex[2] = {{&txl->depth, DRW_BUF_DEPTH_24},
124          *                         {&txl->color, DRW_BUF_RGBA_8}};
125          */
126
127         /* DRW_framebuffer_init takes care of checking if
128          * the framebuffer is valid and has the right size*/
129         /*
130          * float *viewport_size = DRW_viewport_size_get();
131          * DRW_framebuffer_init(&fbl->occlude_wire_fb,
132          *                     (int)viewport_size[0], (int)viewport_size[1],
133          *                     tex, 2);
134          */
135
136         if (!custom_shader) {
137                 custom_shader = GPU_shader_get_builtin_shader(GPU_SHADER_3D_UNIFORM_COLOR);
138         }
139 }
140
141 /* Here init all passes and shading groups
142  * Assume that all Passes are NULL */
143 static void PARTICLE_cache_init(void)
144 {
145         vedata = DRW_viewport_engine_data_get("ParticleMode");
146         PARTICLE_PassList *psl = vedata->psl;
147         PARTICLE_StorageList *stl = vedata->stl;
148
149         {
150                 /* Create a pass */
151                 DRWState state = DRW_STATE_WRITE_COLOR | DRW_STATE_WRITE_DEPTH | DRW_STATE_DEPTH_LESS | DRW_STATE_BLEND | DRW_STATE_WIRE;
152                 psl->pass = DRW_pass_create("My Pass", state);
153
154                 /* Create a shadingGroup using a function in draw_common.c or custom one */
155                 /*
156                  * group = shgroup_dynlines_uniform_color(psl->pass, ts.colorWire);
157                  * -- or --
158                  * group = DRW_shgroup_create(custom_shader, psl->pass);
159                  */
160                 group = DRW_shgroup_create(custom_shader, psl->pass);
161
162                 /* Uniforms need a pointer to it's value so be sure it's accessible at
163                  * any given time (i.e. use static vars) */
164                 static float color[4] = {0.2f, 0.5f, 0.3f, 1.0};
165                 DRW_shgroup_uniform_vec4(group, "color", color, 1);
166         }
167
168 }
169
170 /* Add geometry to shadingGroups. Execute for each objects */
171 static void PARTICLE_cache_populate(Object *ob)
172 {
173         PARTICLE_PassList *psl = vedata->psl;
174         PARTICLE_StorageList *stl = vedata->stl;
175
176         if (ob->type == OB_MESH) {
177                 /* Get geometry cache */
178                 struct Batch *geom = DRW_cache_surface_get(ob);
179
180                 /* Add geom to a shading group */
181                 DRW_shgroup_call_add(group, geom, ob->obmat);
182         }
183 }
184
185 /* Optionnal : Post-cache_populate callback */
186 static void PARTICLE_cache_finish(void)
187 {
188         PARTICLE_PassList *psl = vedata->psl;
189         PARTICLE_StorageList *stl = vedata->stl;
190
191         /* Do something here! dependant on the objects gathered */
192 }
193
194 /* Draw time ! Control rendering pipeline from here */
195 static void PARTICLE_draw_scene(void)
196 {
197         PARTICLE_Data *ved = DRW_viewport_engine_data_get("ParticleMode");
198         PARTICLE_PassList *psl = ved->psl;
199         PARTICLE_FramebufferList *fbl = vedata->fbl;
200
201         /* Default framebuffer and texture */
202         DefaultFramebufferList *dfbl = DRW_viewport_framebuffer_list_get();
203         DefaultTextureList *dtxl = DRW_viewport_texture_list_get();
204
205         /* Show / hide entire passes, swap framebuffers ... whatever you fancy */
206         /*
207          * DRW_framebuffer_texture_detach(dtxl->depth);
208          * DRW_framebuffer_bind(fbl->custom_fb);
209          * DRW_draw_pass(psl->pass);
210          * DRW_framebuffer_texture_attach(dfbl->default_fb, dtxl->depth, 0);
211          * DRW_framebuffer_bind(dfbl->default_fb);
212          */
213
214         /* ... or just render passes on default framebuffer. */
215         DRW_draw_pass(psl->pass);
216
217         /* If you changed framebuffer, double check you rebind
218          * the default one with its textures attached before finishing */
219 }
220
221 /* Cleanup when destroying the engine.
222  * This is not per viewport ! only when quitting blender.
223  * Mostly used for freeing shaders */
224 static void PARTICLE_engine_free(void)
225 {
226         // if (custom_shader)
227         //      DRW_shader_free(custom_shader);
228 }
229
230 /* Create collection settings here.
231  *
232  * Be sure to add this function there :
233  * source/blender/draw/DRW_engine.h
234  * source/blender/blenkernel/intern/layer.c
235  * source/blenderplayer/bad_level_call_stubs/stubs.c
236  *
237  * And relevant collection settings to :
238  * source/blender/makesrna/intern/rna_scene.c
239  * source/blender/blenkernel/intern/layer.c
240  */
241 void PARTICLE_collection_settings_create(CollectionEngineSettings *ces)
242 {
243         BLI_assert(ces);
244         // BKE_collection_engine_property_add_int(ces, "my_bool_prop", false);
245         // BKE_collection_engine_property_add_int(ces, "my_int_prop", 0);
246         // BKE_collection_engine_property_add_float(ces, "my_float_prop", 0.0f);
247 }
248
249 DrawEngineType draw_engine_particle_type = {
250         NULL, NULL,
251         N_("ParticleMode"),
252         &PARTICLE_engine_init,
253         &PARTICLE_engine_free,
254         &PARTICLE_cache_init,
255         &PARTICLE_cache_populate,
256         &PARTICLE_cache_finish,
257         NULL, /* draw_background but not needed by mode engines */
258         &PARTICLE_draw_scene
259 };