Fix T56657: Crash when creating a collection instance containing probes
[blender.git] / source / blender / draw / modes / edit_surface_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/edit_surface_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 EDIT_SURFACE_engine_init() to
46  * initialize most of them and EDIT_SURFACE_cache_init()
47  * for EDIT_SURFACE_PassList */
48
49 typedef struct EDIT_SURFACE_PassList {
50         /* Declare all passes here and init them in
51          * EDIT_SURFACE_cache_init().
52          * Only contains (DRWPass *) */
53         struct DRWPass *pass;
54 } EDIT_SURFACE_PassList;
55
56 typedef struct EDIT_SURFACE_FramebufferList {
57         /* Contains all framebuffer objects needed by this engine.
58          * Only contains (GPUFrameBuffer *) */
59         struct GPUFrameBuffer *fb;
60 } EDIT_SURFACE_FramebufferList;
61
62 typedef struct EDIT_SURFACE_TextureList {
63         /* Contains all framebuffer textures / utility textures
64          * needed by this engine. Only viewport specific textures
65          * (not per object). Only contains (GPUTexture *) */
66         struct GPUTexture *texture;
67 } EDIT_SURFACE_TextureList;
68
69 typedef struct EDIT_SURFACE_StorageList {
70         /* Contains any other memory block that the engine needs.
71          * Only directly MEM_(m/c)allocN'ed blocks because they are
72          * free with MEM_freeN() when viewport is freed.
73          * (not per object) */
74         struct CustomStruct *block;
75         struct EDIT_SURFACE_PrivateData *g_data;
76 } EDIT_SURFACE_StorageList;
77
78 typedef struct EDIT_SURFACE_Data {
79         /* Struct returned by DRW_viewport_engine_data_ensure.
80          * If you don't use one of these, just make it a (void *) */
81         // void *fbl;
82         void *engine_type; /* Required */
83         EDIT_SURFACE_FramebufferList *fbl;
84         EDIT_SURFACE_TextureList *txl;
85         EDIT_SURFACE_PassList *psl;
86         EDIT_SURFACE_StorageList *stl;
87 } EDIT_SURFACE_Data;
88
89 /* *********** STATIC *********** */
90
91 static struct {
92         /* Custom shaders :
93          * Add sources to source/blender/draw/modes/shaders
94          * init in EDIT_SURFACE_engine_init();
95          * free in EDIT_SURFACE_engine_free(); */
96         struct GPUShader *custom_shader;
97 } e_data = {NULL}; /* Engine data */
98
99 typedef struct EDIT_SURFACE_PrivateData {
100         /* This keeps the references of the shading groups for
101          * easy access in EDIT_SURFACE_cache_populate() */
102         DRWShadingGroup *group;
103 } EDIT_SURFACE_PrivateData; /* Transient data */
104
105 /* *********** FUNCTIONS *********** */
106
107 /* Init Textures, Framebuffers, Storage and Shaders.
108  * It is called for every frames.
109  * (Optional) */
110 static void EDIT_SURFACE_engine_init(void *vedata)
111 {
112         EDIT_SURFACE_TextureList *txl = ((EDIT_SURFACE_Data *)vedata)->txl;
113         EDIT_SURFACE_FramebufferList *fbl = ((EDIT_SURFACE_Data *)vedata)->fbl;
114         EDIT_SURFACE_StorageList *stl = ((EDIT_SURFACE_Data *)vedata)->stl;
115
116         UNUSED_VARS(txl, fbl, stl);
117
118         /* Init Framebuffers like this: order is attachment order (for color texs) */
119         /*
120          * DRWFboTexture tex[2] = {{&txl->depth, GPU_DEPTH_COMPONENT24, 0},
121          *                         {&txl->color, GPU_RGBA8, DRW_TEX_FILTER}};
122          */
123
124         /* DRW_framebuffer_init takes care of checking if
125          * the framebuffer is valid and has the right size*/
126         /*
127          * float *viewport_size = DRW_viewport_size_get();
128          * DRW_framebuffer_init(&fbl->occlude_wire_fb,
129          *                     (int)viewport_size[0], (int)viewport_size[1],
130          *                     tex, 2);
131          */
132
133         if (!e_data.custom_shader) {
134                 e_data.custom_shader = GPU_shader_get_builtin_shader(GPU_SHADER_3D_UNIFORM_COLOR);
135         }
136 }
137
138 /* Here init all passes and shading groups
139  * Assume that all Passes are NULL */
140 static void EDIT_SURFACE_cache_init(void *vedata)
141 {
142         EDIT_SURFACE_PassList *psl = ((EDIT_SURFACE_Data *)vedata)->psl;
143         EDIT_SURFACE_StorageList *stl = ((EDIT_SURFACE_Data *)vedata)->stl;
144
145         if (!stl->g_data) {
146                 /* Alloc transient pointers */
147                 stl->g_data = MEM_mallocN(sizeof(*stl->g_data), __func__);
148         }
149
150         {
151                 /* Create a pass */
152                 DRWState state = (
153                         DRW_STATE_WRITE_COLOR | DRW_STATE_WRITE_DEPTH | DRW_STATE_DEPTH_LESS_EQUAL |
154                         DRW_STATE_BLEND | DRW_STATE_WIRE);
155                 psl->pass = DRW_pass_create("My Pass", state);
156
157                 /* Create a shadingGroup using a function in draw_common.c or custom one */
158                 /*
159                  * stl->g_data->group = shgroup_dynlines_uniform_color(psl->pass, ts.colorWire);
160                  * -- or --
161                  * stl->g_data->group = DRW_shgroup_create(e_data.custom_shader, psl->pass);
162                  */
163                 stl->g_data->group = DRW_shgroup_create(e_data.custom_shader, psl->pass);
164
165                 /* Uniforms need a pointer to it's value so be sure it's accessible at
166                  * any given time (i.e. use static vars) */
167                 static float color[4] = {0.0f, 0.0f, 1.0f, 1.0};
168                 DRW_shgroup_uniform_vec4(stl->g_data->group, "color", color, 1);
169         }
170
171 }
172
173 /* Add geometry to shadingGroups. Execute for each objects */
174 static void EDIT_SURFACE_cache_populate(void *vedata, Object *ob)
175 {
176         EDIT_SURFACE_PassList *psl = ((EDIT_SURFACE_Data *)vedata)->psl;
177         EDIT_SURFACE_StorageList *stl = ((EDIT_SURFACE_Data *)vedata)->stl;
178
179         UNUSED_VARS(psl, stl);
180
181         if (ob->type == OB_MESH) {
182                 /* Get geometry cache */
183                 struct GPUBatch *geom = DRW_cache_mesh_surface_get(ob);
184
185                 /* Add geom to a shading group */
186                 DRW_shgroup_call_add(stl->g_data->group, geom, ob->obmat);
187         }
188 }
189
190 /* Optional: Post-cache_populate callback */
191 static void EDIT_SURFACE_cache_finish(void *vedata)
192 {
193         EDIT_SURFACE_PassList *psl = ((EDIT_SURFACE_Data *)vedata)->psl;
194         EDIT_SURFACE_StorageList *stl = ((EDIT_SURFACE_Data *)vedata)->stl;
195
196         /* Do something here! dependant on the objects gathered */
197         UNUSED_VARS(psl, stl);
198 }
199
200 /* Draw time ! Control rendering pipeline from here */
201 static void EDIT_SURFACE_draw_scene(void *vedata)
202 {
203         EDIT_SURFACE_PassList *psl = ((EDIT_SURFACE_Data *)vedata)->psl;
204         EDIT_SURFACE_FramebufferList *fbl = ((EDIT_SURFACE_Data *)vedata)->fbl;
205
206         /* Default framebuffer and texture */
207         DefaultFramebufferList *dfbl = DRW_viewport_framebuffer_list_get();
208         DefaultTextureList *dtxl = DRW_viewport_texture_list_get();
209
210         UNUSED_VARS(fbl, dfbl, dtxl);
211
212         /* Show / hide entire passes, swap framebuffers ... whatever you fancy */
213         /*
214          * DRW_framebuffer_texture_detach(dtxl->depth);
215          * DRW_framebuffer_bind(fbl->custom_fb);
216          * DRW_draw_pass(psl->pass);
217          * DRW_framebuffer_texture_attach(dfbl->default_fb, dtxl->depth, 0, 0);
218          * DRW_framebuffer_bind(dfbl->default_fb);
219          */
220
221         /* ... or just render passes on default framebuffer. */
222         DRW_draw_pass(psl->pass);
223
224         /* If you changed framebuffer, double check you rebind
225          * the default one with its textures attached before finishing */
226 }
227
228 /* Cleanup when destroying the engine.
229  * This is not per viewport ! only when quitting blender.
230  * Mostly used for freeing shaders */
231 static void EDIT_SURFACE_engine_free(void)
232 {
233         // DRW_SHADER_FREE_SAFE(custom_shader);
234 }
235
236 static const DrawEngineDataSize EDIT_SURFACE_data_size = DRW_VIEWPORT_DATA_SIZE(EDIT_SURFACE_Data);
237
238 DrawEngineType draw_engine_edit_surface_type = {
239         NULL, NULL,
240         N_("EditSurfaceMode"),
241         &EDIT_SURFACE_data_size,
242         &EDIT_SURFACE_engine_init,
243         &EDIT_SURFACE_engine_free,
244         &EDIT_SURFACE_cache_init,
245         &EDIT_SURFACE_cache_populate,
246         &EDIT_SURFACE_cache_finish,
247         NULL, /* draw_background but not needed by mode engines */
248         &EDIT_SURFACE_draw_scene,
249         NULL,
250         NULL,
251 };