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