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