Cleanup: macro hygiene, line length
[blender.git] / source / blender / draw / intern / draw_cache_impl.h
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 draw_cache_impl.h
23  *  \ingroup draw
24  */
25
26 #ifndef __DRAW_CACHE_IMPL_H__
27 #define __DRAW_CACHE_IMPL_H__
28
29 struct CurveCache;
30 struct GPUMaterial;
31 struct GPUTexture;
32 struct GPUBatch;
33 struct GPUIndexBuf;
34 struct GPUVertBuf;
35 struct ListBase;
36 struct ModifierData;
37 struct ParticleSystem;
38 struct PTCacheEdit;
39 struct SpaceImage;
40
41 struct Curve;
42 struct Lattice;
43 struct Mesh;
44 struct MetaBall;
45 struct bGPdata;
46
47 /* Expose via BKE callbacks */
48 void DRW_mball_batch_cache_dirty_tag(struct MetaBall *mb, int mode);
49 void DRW_mball_batch_cache_free(struct MetaBall *mb);
50
51 void DRW_curve_batch_cache_dirty_tag(struct Curve *cu, int mode);
52 void DRW_curve_batch_cache_free(struct Curve *cu);
53
54 void DRW_mesh_batch_cache_dirty_tag(struct Mesh *me, int mode);
55 void DRW_mesh_batch_cache_free(struct Mesh *me);
56
57 void DRW_lattice_batch_cache_dirty_tag(struct Lattice *lt, int mode);
58 void DRW_lattice_batch_cache_free(struct Lattice *lt);
59
60 void DRW_particle_batch_cache_dirty_tag(struct ParticleSystem *psys, int mode);
61 void DRW_particle_batch_cache_free(struct ParticleSystem *psys);
62
63 void DRW_gpencil_batch_cache_dirty_tag(struct bGPdata *gpd);
64 void DRW_gpencil_batch_cache_free(struct bGPdata *gpd);
65
66 /* Curve */
67 void DRW_curve_batch_cache_create_requested(struct Object *ob);
68
69 struct GPUBatch *DRW_curve_batch_cache_get_wire_edge(struct Curve *cu);
70 struct GPUBatch *DRW_curve_batch_cache_get_normal_edge(struct Curve *cu);
71 struct GPUBatch *DRW_curve_batch_cache_get_edit_edges(struct Curve *cu);
72 struct GPUBatch *DRW_curve_batch_cache_get_edit_verts(struct Curve *cu, bool handles);
73
74 struct GPUBatch *DRW_curve_batch_cache_get_triangles_with_normals(struct Curve *cu);
75 struct GPUBatch **DRW_curve_batch_cache_get_surface_shaded(
76         struct Curve *cu, struct GPUMaterial **gpumat_array, uint gpumat_array_len);
77 struct GPUBatch *DRW_curve_batch_cache_get_wireframes_face(struct Curve *cu);
78
79 /* Metaball */
80 struct GPUBatch *DRW_metaball_batch_cache_get_triangles_with_normals(struct Object *ob);
81 struct GPUBatch **DRW_metaball_batch_cache_get_surface_shaded(
82         struct Object *ob, struct MetaBall *mb, struct GPUMaterial **gpumat_array, uint gpumat_array_len);
83 struct GPUBatch *DRW_metaball_batch_cache_get_wireframes_face(struct Object *ob);
84
85 /* DispList */
86 void DRW_displist_vertbuf_create_pos_and_nor(struct ListBase *lb, struct GPUVertBuf *vbo);
87 void DRW_displist_vertbuf_create_pos_and_nor_and_uv_tess(
88         struct ListBase *lb, struct GPUVertBuf *vbo_pos_nor, struct GPUVertBuf *vbo_uv);
89 void DRW_displist_vertbuf_create_wireframe_data_tess(struct ListBase *lb, struct GPUVertBuf *vbo);
90 void DRW_displist_indexbuf_create_triangles_in_order(struct ListBase *lb, struct GPUIndexBuf *vbo);
91 void DRW_displist_indexbuf_create_triangles_tess_split_by_material(
92         struct ListBase *lb, struct GPUIndexBuf **ibo_mat, uint mat_len);
93
94 /* Lattice */
95 struct GPUBatch *DRW_lattice_batch_cache_get_all_edges(struct Lattice *lt, bool use_weight, const int actdef);
96 struct GPUBatch *DRW_lattice_batch_cache_get_all_verts(struct Lattice *lt);
97 struct GPUBatch *DRW_lattice_batch_cache_get_edit_verts(struct Lattice *lt);
98
99 /* Mesh */
100 void DRW_mesh_batch_cache_create_requested(struct Object *ob, struct Mesh *me);
101
102 struct GPUBatch *DRW_mesh_batch_cache_get_all_verts(struct Mesh *me);
103 struct GPUBatch *DRW_mesh_batch_cache_get_all_edges(struct Mesh *me);
104 struct GPUBatch *DRW_mesh_batch_cache_get_loose_edges(struct Mesh *me);
105 struct GPUBatch *DRW_mesh_batch_cache_get_edge_detection(struct Mesh *me, bool *r_is_manifold);
106 struct GPUBatch *DRW_mesh_batch_cache_get_surface(struct Mesh *me);
107 struct GPUBatch *DRW_mesh_batch_cache_get_surface_edges(struct Mesh *me);
108 struct GPUBatch **DRW_mesh_batch_cache_get_surface_shaded(
109         struct Mesh *me, struct GPUMaterial **gpumat_array, uint gpumat_array_len,
110         char **auto_layer_names, int **auto_layer_is_srgb, int *auto_layer_count);
111 struct GPUBatch **DRW_mesh_batch_cache_get_surface_texpaint(struct Mesh *me);
112 struct GPUBatch *DRW_mesh_batch_cache_get_surface_texpaint_single(struct Mesh *me);
113 struct GPUBatch *DRW_mesh_batch_cache_get_surface_vertpaint(struct Mesh *me);
114 struct GPUBatch *DRW_mesh_batch_cache_get_surface_weights(struct Mesh *me);
115 /* edit-mesh drawing */
116 struct GPUBatch *DRW_mesh_batch_cache_get_edit_triangles(struct Mesh *me);
117 struct GPUBatch *DRW_mesh_batch_cache_get_edit_triangles_nor(struct Mesh *me);
118 struct GPUBatch *DRW_mesh_batch_cache_get_edit_triangles_lnor(struct Mesh *me);
119 struct GPUBatch *DRW_mesh_batch_cache_get_edit_vertices(struct Mesh *me);
120 struct GPUBatch *DRW_mesh_batch_cache_get_edit_loose_edges(struct Mesh *me);
121 struct GPUBatch *DRW_mesh_batch_cache_get_edit_loose_edges_nor(struct Mesh *me);
122 struct GPUBatch *DRW_mesh_batch_cache_get_edit_loose_verts(struct Mesh *me);
123 struct GPUBatch *DRW_mesh_batch_cache_get_edit_facedots(struct Mesh *me);
124 /* edit-mesh selection */
125 struct GPUBatch *DRW_mesh_batch_cache_get_triangles_with_select_id(struct Mesh *me, bool use_hide, uint select_id_offset);
126 struct GPUBatch *DRW_mesh_batch_cache_get_triangles_with_select_mask(struct Mesh *me, bool use_hide);
127 struct GPUBatch *DRW_mesh_batch_cache_get_facedots_with_select_id(struct Mesh *me, uint select_id_offset);
128 struct GPUBatch *DRW_mesh_batch_cache_get_edges_with_select_id(struct Mesh *me, uint select_id_offset);
129 struct GPUBatch *DRW_mesh_batch_cache_get_verts_with_select_id(struct Mesh *me, uint select_id_offset);
130 /* Object mode Wireframe overlays */
131 struct GPUBatch *DRW_mesh_batch_cache_get_wireframes_face(struct Mesh *me);
132
133 void DRW_mesh_cache_sculpt_coords_ensure(struct Mesh *me);
134
135 enum {
136         UVEDIT_EDGES          = (1 << 0),
137         UVEDIT_DATA           = (1 << 1),
138         UVEDIT_FACEDOTS       = (1 << 2),
139         UVEDIT_FACES          = (1 << 3),
140         UVEDIT_STRETCH_ANGLE  = (1 << 4),
141         UVEDIT_STRETCH_AREA   = (1 << 5),
142         UVEDIT_SYNC_SEL       = (1 << 6),
143 };
144
145 /* For Image UV editor. */
146 struct GPUBatch *DRW_mesh_batch_cache_get_texpaint_loop_wire(struct Mesh *me);
147 void DRW_mesh_cache_uvedit(
148         struct Object *me, struct SpaceImage *sima, struct Scene *scene, uchar state,
149         struct GPUBatch **faces, struct GPUBatch **edges, struct GPUBatch **verts, struct GPUBatch **facedots);
150
151 /* Edit mesh bitflags (is this the right place?) */
152
153 enum {
154         VFLAG_VERTEX_ACTIVE   = 1 << 0,
155         VFLAG_VERTEX_SELECTED = 1 << 1,
156         VFLAG_VERTEX_EXISTS   = 1 << 2,
157         VFLAG_FACE_ACTIVE     = 1 << 3,
158         VFLAG_FACE_SELECTED   = 1 << 4,
159         VFLAG_FACE_FREESTYLE  = 1 << 5,
160         /* Beware to not go over 1 << 7 (it's a byte flag)
161          * (see gpu_shader_edit_mesh_overlay_geom.glsl) */
162 };
163
164 enum {
165         VFLAG_EDGE_EXISTS   = 1 << 0,
166         VFLAG_EDGE_ACTIVE   = 1 << 1,
167         VFLAG_EDGE_SELECTED = 1 << 2,
168         VFLAG_EDGE_SEAM     = 1 << 3,
169         VFLAG_EDGE_SHARP    = 1 << 4,
170         VFLAG_EDGE_FREESTYLE = 1 << 5,
171         /* Beware to not go over 1 << 7 (it's a byte flag)
172          * (see gpu_shader_edit_mesh_overlay_geom.glsl) */
173 };
174
175 /* Particles */
176 struct GPUBatch *DRW_particles_batch_cache_get_hair(
177         struct Object *object, struct ParticleSystem *psys, struct ModifierData *md);
178 struct GPUBatch *DRW_particles_batch_cache_get_dots(
179         struct Object *object, struct ParticleSystem *psys);
180 struct GPUBatch *DRW_particles_batch_cache_get_edit_strands(
181         struct Object *object, struct ParticleSystem *psys, struct PTCacheEdit *edit, bool use_weight);
182 struct GPUBatch *DRW_particles_batch_cache_get_edit_inner_points(
183         struct Object *object, struct ParticleSystem *psys, struct PTCacheEdit *edit);
184 struct GPUBatch *DRW_particles_batch_cache_get_edit_tip_points(
185         struct Object *object, struct ParticleSystem *psys, struct PTCacheEdit *edit);
186
187 /* Common */
188 #define DRW_ADD_FLAG_FROM_VBO_REQUEST(flag, vbo, value) (flag |= DRW_vbo_requested(vbo) ? (value) : 0)
189 #define DRW_ADD_FLAG_FROM_IBO_REQUEST(flag, ibo, value) (flag |= DRW_ibo_requested(ibo) ? (value) : 0)
190
191 /* Test and assign NULL if test fails */
192 #define DRW_TEST_ASSIGN_VBO(v) (v = (DRW_vbo_requested(v) ? (v) : NULL))
193 #define DRW_TEST_ASSIGN_IBO(v) (v = (DRW_ibo_requested(v) ? (v) : NULL))
194
195 struct GPUBatch *DRW_batch_request(struct GPUBatch **batch);
196 bool DRW_batch_requested(struct GPUBatch *batch, int prim_type);
197 void DRW_ibo_request(struct GPUBatch *batch, struct GPUIndexBuf **ibo);
198 bool DRW_ibo_requested(struct GPUIndexBuf *ibo);
199 void DRW_vbo_request(struct GPUBatch *batch, struct GPUVertBuf **vbo);
200 bool DRW_vbo_requested(struct GPUVertBuf *vbo);
201
202 #endif /* __DRAW_CACHE_IMPL_H__ */