d316f63ffa29ad66634c6b3090448f8799d0bdf2
[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 struct GPUBatch *DRW_curve_batch_cache_get_wire_edge(struct Curve *cu, struct CurveCache *ob_curve_cache);
68 struct GPUBatch *DRW_curve_batch_cache_get_normal_edge(
69         struct Curve *cu, struct CurveCache *ob_curve_cache, float normal_size);
70 struct GPUBatch *DRW_curve_batch_cache_get_overlay_edges(struct Curve *cu);
71 struct GPUBatch *DRW_curve_batch_cache_get_overlay_verts(struct Curve *cu, bool handles);
72
73 struct GPUBatch *DRW_curve_batch_cache_get_triangles_with_normals(
74         struct Curve *cu, struct CurveCache *ob_curve_cache);
75 struct GPUBatch **DRW_curve_batch_cache_get_surface_shaded(
76         struct Curve *cu, struct CurveCache *ob_curve_cache,
77         struct GPUMaterial **gpumat_array, uint gpumat_array_len);
78 struct GPUBatch *DRW_curve_batch_cache_get_wireframes_face(struct Curve *cu, struct CurveCache *ob_curve_cache);
79
80 /* Metaball */
81 struct GPUBatch *DRW_metaball_batch_cache_get_triangles_with_normals(struct Object *ob);
82 struct GPUBatch **DRW_metaball_batch_cache_get_surface_shaded(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 /* Curve (Font) */
86 struct GPUBatch *DRW_curve_batch_cache_get_overlay_cursor(struct Curve *cu);
87 struct GPUBatch *DRW_curve_batch_cache_get_overlay_select(struct Curve *cu);
88
89 /* DispList */
90 struct GPUVertBuf *DRW_displist_vertbuf_calc_pos_with_normals(struct ListBase *lb);
91 struct GPUIndexBuf *DRW_displist_indexbuf_calc_triangles_in_order(struct ListBase *lb);
92 struct GPUIndexBuf **DRW_displist_indexbuf_calc_triangles_in_order_split_by_material(
93         struct ListBase *lb, uint gpumat_array_len);
94 struct GPUBatch **DRW_displist_batch_calc_tri_pos_normals_and_uv_split_by_material(
95         struct ListBase *lb, uint gpumat_array_len);
96 struct GPUBatch *DRW_displist_create_edges_overlay_batch(ListBase *lb);
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_overlay_verts(struct Lattice *lt);
102
103 /* Vertex Group Selection and display options */
104 struct DRW_MeshWeightState {
105         int defgroup_active;
106         int defgroup_len;
107
108         short flags;
109         char alert_mode;
110
111         /* Set of all selected bones for Multipaint. */
112         bool *defgroup_sel; /* [defgroup_len] */
113         int   defgroup_sel_count;
114 };
115
116 /* DRW_MeshWeightState.flags */
117 enum {
118         DRW_MESH_WEIGHT_STATE_MULTIPAINT          = (1 << 0),
119         DRW_MESH_WEIGHT_STATE_AUTO_NORMALIZE      = (1 << 1),
120 };
121
122 void DRW_mesh_weight_state_clear(struct DRW_MeshWeightState *wstate);
123 void DRW_mesh_weight_state_copy(struct DRW_MeshWeightState *wstate_dst, const struct DRW_MeshWeightState *wstate_src);
124 bool DRW_mesh_weight_state_compare(const struct DRW_MeshWeightState *a, const struct DRW_MeshWeightState *b);
125
126 /* Mesh */
127 struct GPUBatch **DRW_mesh_batch_cache_get_surface_shaded(
128         struct Mesh *me, struct GPUMaterial **gpumat_array, uint gpumat_array_len, bool use_hide,
129         char **auto_layer_names, int **auto_layer_is_srgb, int *auto_layer_count);
130 struct GPUBatch **DRW_mesh_batch_cache_get_surface_texpaint(struct Mesh *me, bool use_hide);
131 struct GPUBatch *DRW_mesh_batch_cache_get_surface_texpaint_single(struct Mesh *me);
132 struct GPUBatch *DRW_mesh_batch_cache_get_weight_overlay_edges(struct Mesh *me, bool use_wire, bool use_sel, bool use_hide);
133 struct GPUBatch *DRW_mesh_batch_cache_get_weight_overlay_faces(struct Mesh *me);
134 struct GPUBatch *DRW_mesh_batch_cache_get_weight_overlay_verts(struct Mesh *me);
135 struct GPUBatch *DRW_mesh_batch_cache_get_all_edges(struct Mesh *me);
136 struct GPUBatch *DRW_mesh_batch_cache_get_all_triangles(struct Mesh *me);
137 struct GPUBatch *DRW_mesh_batch_cache_get_triangles_with_normals(struct Mesh *me, bool use_hide);
138 struct GPUBatch *DRW_mesh_batch_cache_get_triangles_with_normals_and_weights(struct Mesh *me, const struct DRW_MeshWeightState *wstate);
139 struct GPUBatch *DRW_mesh_batch_cache_get_triangles_with_normals_and_vert_colors(struct Mesh *me);
140 struct GPUBatch *DRW_mesh_batch_cache_get_triangles_with_select_id(struct Mesh *me, bool use_hide, uint select_id_offset);
141 struct GPUBatch *DRW_mesh_batch_cache_get_triangles_with_select_mask(struct Mesh *me, bool use_hide);
142 struct GPUBatch *DRW_mesh_batch_cache_get_loose_edges_with_normals(struct Mesh *me);
143 struct GPUBatch *DRW_mesh_batch_cache_get_points_with_normals(struct Mesh *me);
144 struct GPUBatch *DRW_mesh_batch_cache_get_all_verts(struct Mesh *me);
145 struct GPUBatch *DRW_mesh_batch_cache_get_fancy_edges(struct Mesh *me);
146 struct GPUBatch *DRW_mesh_batch_cache_get_edge_detection(struct Mesh *me, bool *r_is_manifold);
147 struct GPUBatch *DRW_mesh_batch_cache_get_overlay_triangles(struct Mesh *me);
148 struct GPUBatch *DRW_mesh_batch_cache_get_overlay_triangles_nor(struct Mesh *me);
149 struct GPUBatch *DRW_mesh_batch_cache_get_overlay_triangles_lnor(struct Mesh *me);
150 struct GPUBatch *DRW_mesh_batch_cache_get_overlay_verts(struct Mesh *me);
151 struct GPUBatch *DRW_mesh_batch_cache_get_overlay_loose_edges(struct Mesh *me);
152 struct GPUBatch *DRW_mesh_batch_cache_get_overlay_loose_edges_nor(struct Mesh *me);
153 struct GPUBatch *DRW_mesh_batch_cache_get_overlay_loose_verts(struct Mesh *me);
154 struct GPUBatch *DRW_mesh_batch_cache_get_overlay_facedots(struct Mesh *me);
155 struct GPUTexture *DRW_mesh_batch_cache_get_overlay_data_tex(struct Mesh *me);
156 /* edit-mesh selection (use generic function for faces) */
157 struct GPUBatch *DRW_mesh_batch_cache_get_facedots_with_select_id(struct Mesh *me, uint select_id_offset);
158 struct GPUBatch *DRW_mesh_batch_cache_get_edges_with_select_id(struct Mesh *me, uint select_id_offset);
159 struct GPUBatch *DRW_mesh_batch_cache_get_verts_with_select_id(struct Mesh *me, uint select_id_offset);
160 /* Object mode Wireframe overlays */
161 struct GPUBatch *DRW_mesh_batch_cache_get_wireframes_face(struct Mesh *me);
162
163 void DRW_mesh_cache_sculpt_coords_ensure(struct Mesh *me);
164
165 enum {
166         UVEDIT_EDGES          = (1 << 0),
167         UVEDIT_DATA           = (1 << 1),
168         UVEDIT_FACEDOTS       = (1 << 2),
169         UVEDIT_FACES          = (1 << 3),
170         UVEDIT_STRETCH_ANGLE  = (1 << 4),
171         UVEDIT_STRETCH_AREA   = (1 << 5),
172         UVEDIT_SYNC_SEL       = (1 << 6),
173 };
174
175 /* For Image UV editor. */
176 struct GPUBatch *DRW_mesh_batch_cache_get_texpaint_loop_wire(struct Mesh *me);
177 void DRW_mesh_cache_uvedit(
178         struct Object *me, struct SpaceImage *sima, struct Scene *scene, uchar state,
179         struct GPUBatch **faces, struct GPUBatch **edges, struct GPUBatch **verts, struct GPUBatch **facedots);
180
181 /* Edit mesh bitflags (is this the right place?) */
182
183 enum {
184         VFLAG_VERTEX_ACTIVE   = 1 << 0,
185         VFLAG_VERTEX_SELECTED = 1 << 1,
186         VFLAG_VERTEX_EXISTS   = 1 << 2,
187         VFLAG_FACE_ACTIVE     = 1 << 3,
188         VFLAG_FACE_SELECTED   = 1 << 4,
189         VFLAG_FACE_FREESTYLE  = 1 << 5,
190         /* Beware to not go over 1 << 7 (it's a byte flag)
191          * (see gpu_shader_edit_mesh_overlay_geom.glsl) */
192 };
193
194 enum {
195         VFLAG_EDGE_EXISTS   = 1 << 0,
196         VFLAG_EDGE_ACTIVE   = 1 << 1,
197         VFLAG_EDGE_SELECTED = 1 << 2,
198         VFLAG_EDGE_SEAM     = 1 << 3,
199         VFLAG_EDGE_SHARP    = 1 << 4,
200         VFLAG_EDGE_FREESTYLE = 1 << 5,
201         /* Beware to not go over 1 << 7 (it's a byte flag)
202          * (see gpu_shader_edit_mesh_overlay_geom.glsl) */
203 };
204
205 /* Particles */
206 struct GPUBatch *DRW_particles_batch_cache_get_hair(
207         struct Object *object, struct ParticleSystem *psys, struct ModifierData *md);
208 struct GPUBatch *DRW_particles_batch_cache_get_dots(
209         struct Object *object, struct ParticleSystem *psys);
210 struct GPUBatch *DRW_particles_batch_cache_get_edit_strands(
211         struct Object *object, struct ParticleSystem *psys, struct PTCacheEdit *edit, bool use_weight);
212 struct GPUBatch *DRW_particles_batch_cache_get_edit_inner_points(
213         struct Object *object, struct ParticleSystem *psys, struct PTCacheEdit *edit);
214 struct GPUBatch *DRW_particles_batch_cache_get_edit_tip_points(
215         struct Object *object, struct ParticleSystem *psys, struct PTCacheEdit *edit);
216
217 #endif /* __DRAW_CACHE_IMPL_H__ */