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