doxygen: add newline after \file
[blender.git] / source / blender / draw / intern / draw_cache_impl.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * Copyright 2016, Blender Foundation.
17  */
18
19 /** \file
20  * \ingroup draw
21  */
22
23 #ifndef __DRAW_CACHE_IMPL_H__
24 #define __DRAW_CACHE_IMPL_H__
25
26 struct CurveCache;
27 struct GPUBatch;
28 struct GPUIndexBuf;
29 struct GPUMaterial;
30 struct GPUTexture;
31 struct GPUVertBuf;
32 struct ListBase;
33 struct ModifierData;
34 struct PTCacheEdit;
35 struct ParticleSystem;
36 struct SpaceImage;
37 struct ToolSettings;
38
39 struct Curve;
40 struct Lattice;
41 struct Mesh;
42 struct MetaBall;
43 struct bGPdata;
44
45 /* Expose via BKE callbacks */
46 void DRW_mball_batch_cache_dirty_tag(struct MetaBall *mb, int mode);
47 void DRW_mball_batch_cache_free(struct MetaBall *mb);
48
49 void DRW_curve_batch_cache_dirty_tag(struct Curve *cu, int mode);
50 void DRW_curve_batch_cache_free(struct Curve *cu);
51
52 void DRW_mesh_batch_cache_dirty_tag(struct Mesh *me, int mode);
53 void DRW_mesh_batch_cache_free(struct Mesh *me);
54
55 void DRW_lattice_batch_cache_dirty_tag(struct Lattice *lt, int mode);
56 void DRW_lattice_batch_cache_free(struct Lattice *lt);
57
58 void DRW_particle_batch_cache_dirty_tag(struct ParticleSystem *psys, int mode);
59 void DRW_particle_batch_cache_free(struct ParticleSystem *psys);
60
61 void DRW_gpencil_batch_cache_dirty_tag(struct bGPdata *gpd);
62 void DRW_gpencil_batch_cache_free(struct bGPdata *gpd);
63
64 /* Curve */
65 void DRW_curve_batch_cache_create_requested(struct Object *ob);
66
67 struct GPUBatch *DRW_curve_batch_cache_get_wire_edge(struct Curve *cu);
68 struct GPUBatch *DRW_curve_batch_cache_get_normal_edge(struct Curve *cu);
69 struct GPUBatch *DRW_curve_batch_cache_get_edit_edges(struct Curve *cu);
70 struct GPUBatch *DRW_curve_batch_cache_get_edit_verts(struct Curve *cu, bool handles);
71
72 struct GPUBatch *DRW_curve_batch_cache_get_triangles_with_normals(struct Curve *cu);
73 struct GPUBatch **DRW_curve_batch_cache_get_surface_shaded(
74         struct Curve *cu, struct GPUMaterial **gpumat_array, uint gpumat_array_len);
75 struct GPUBatch *DRW_curve_batch_cache_get_wireframes_face(struct Curve *cu);
76
77 /* Metaball */
78 struct GPUBatch *DRW_metaball_batch_cache_get_triangles_with_normals(struct Object *ob);
79 struct GPUBatch **DRW_metaball_batch_cache_get_surface_shaded(
80         struct Object *ob, struct MetaBall *mb, struct GPUMaterial **gpumat_array, uint gpumat_array_len);
81 struct GPUBatch *DRW_metaball_batch_cache_get_wireframes_face(struct Object *ob);
82
83 /* DispList */
84 void DRW_displist_vertbuf_create_pos_and_nor(struct ListBase *lb, struct GPUVertBuf *vbo);
85 void DRW_displist_vertbuf_create_pos_and_nor_and_uv_tess(
86         struct ListBase *lb, struct GPUVertBuf *vbo_pos_nor, struct GPUVertBuf *vbo_uv);
87 void DRW_displist_vertbuf_create_wireframe_data_tess(struct ListBase *lb, struct GPUVertBuf *vbo);
88 void DRW_displist_indexbuf_create_triangles_in_order(struct ListBase *lb, struct GPUIndexBuf *vbo);
89 void DRW_displist_indexbuf_create_triangles_tess_split_by_material(
90         struct ListBase *lb, struct GPUIndexBuf **ibo_mat, uint mat_len);
91
92 /* Lattice */
93 struct GPUBatch *DRW_lattice_batch_cache_get_all_edges(struct Lattice *lt, bool use_weight, const int actdef);
94 struct GPUBatch *DRW_lattice_batch_cache_get_all_verts(struct Lattice *lt);
95 struct GPUBatch *DRW_lattice_batch_cache_get_edit_verts(struct Lattice *lt);
96
97 /* Mesh */
98 void DRW_mesh_batch_cache_create_requested(
99         struct Object *ob, struct Mesh *me,
100         const struct ToolSettings *ts, const bool is_paint_mode, const bool use_hide);
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_vertices(struct Mesh *me);
118 struct GPUBatch *DRW_mesh_batch_cache_get_edit_edges(struct Mesh *me);
119 struct GPUBatch *DRW_mesh_batch_cache_get_edit_lnors(struct Mesh *me);
120 struct GPUBatch *DRW_mesh_batch_cache_get_edit_facedots(struct Mesh *me);
121 /* edit-mesh selection */
122 struct GPUBatch *DRW_mesh_batch_cache_get_triangles_with_select_id(struct Mesh *me);
123 struct GPUBatch *DRW_mesh_batch_cache_get_facedots_with_select_id(struct Mesh *me);
124 struct GPUBatch *DRW_mesh_batch_cache_get_edges_with_select_id(struct Mesh *me);
125 struct GPUBatch *DRW_mesh_batch_cache_get_verts_with_select_id(struct Mesh *me);
126 /* Object mode Wireframe overlays */
127 struct GPUBatch *DRW_mesh_batch_cache_get_wireframes_face(struct Mesh *me);
128 /* edit-mesh UV editor */
129 struct GPUBatch *DRW_mesh_batch_cache_get_edituv_faces_strech_area(struct Mesh *me);
130 struct GPUBatch *DRW_mesh_batch_cache_get_edituv_faces_strech_angle(struct Mesh *me);
131 struct GPUBatch *DRW_mesh_batch_cache_get_edituv_faces(struct Mesh *me);
132 struct GPUBatch *DRW_mesh_batch_cache_get_edituv_edges(struct Mesh *me);
133 struct GPUBatch *DRW_mesh_batch_cache_get_edituv_verts(struct Mesh *me);
134 struct GPUBatch *DRW_mesh_batch_cache_get_edituv_facedots(struct Mesh *me);
135 /* For Image UV editor. */
136 struct GPUBatch *DRW_mesh_batch_cache_get_uv_edges(struct Mesh *me);
137
138 void DRW_mesh_cache_sculpt_coords_ensure(struct Mesh *me);
139
140 /* Edit mesh bitflags (is this the right place?) */
141 enum {
142         VFLAG_VERT_ACTIVE    = 1 << 0,
143         VFLAG_VERT_SELECTED  = 1 << 1,
144         VFLAG_EDGE_ACTIVE    = 1 << 2,
145         VFLAG_EDGE_SELECTED  = 1 << 3,
146         VFLAG_EDGE_SEAM      = 1 << 4,
147         VFLAG_EDGE_SHARP     = 1 << 5,
148         VFLAG_EDGE_FREESTYLE = 1 << 6,
149         /* Beware to not go over 1 << 7 (it's a byte flag)
150          * (see gpu_shader_edit_mesh_overlay_geom.glsl) */
151 };
152
153 enum {
154         VFLAG_FACE_ACTIVE     = 1 << 0,
155         VFLAG_FACE_SELECTED   = 1 << 1,
156         VFLAG_FACE_FREESTYLE  = 1 << 2,
157         VFLAG_VERT_UV_SELECT  = 1 << 3,
158         VFLAG_VERT_UV_PINNED  = 1 << 4,
159         VFLAG_EDGE_UV_SELECT  = 1 << 5,
160         VFLAG_FACE_UV_ACTIVE  = 1 << 6,
161         VFLAG_FACE_UV_SELECT  = 1 << 7,
162         /* Beware to not go over 1 << 7 (it's a byte flag)
163          * (see gpu_shader_edit_mesh_overlay_geom.glsl) */
164 };
165
166 /* Particles */
167 struct GPUBatch *DRW_particles_batch_cache_get_hair(
168         struct Object *object, struct ParticleSystem *psys, struct ModifierData *md);
169 struct GPUBatch *DRW_particles_batch_cache_get_dots(
170         struct Object *object, struct ParticleSystem *psys);
171 struct GPUBatch *DRW_particles_batch_cache_get_edit_strands(
172         struct Object *object, struct ParticleSystem *psys, struct PTCacheEdit *edit, bool use_weight);
173 struct GPUBatch *DRW_particles_batch_cache_get_edit_inner_points(
174         struct Object *object, struct ParticleSystem *psys, struct PTCacheEdit *edit);
175 struct GPUBatch *DRW_particles_batch_cache_get_edit_tip_points(
176         struct Object *object, struct ParticleSystem *psys, struct PTCacheEdit *edit);
177
178 /* Common */
179 #define DRW_ADD_FLAG_FROM_VBO_REQUEST(flag, vbo, value) (flag |= DRW_vbo_requested(vbo) ? (value) : 0)
180 #define DRW_ADD_FLAG_FROM_IBO_REQUEST(flag, ibo, value) (flag |= DRW_ibo_requested(ibo) ? (value) : 0)
181
182 /* Test and assign NULL if test fails */
183 #define DRW_TEST_ASSIGN_VBO(v) (v = (DRW_vbo_requested(v) ? (v) : NULL))
184 #define DRW_TEST_ASSIGN_IBO(v) (v = (DRW_ibo_requested(v) ? (v) : NULL))
185
186 struct GPUBatch *DRW_batch_request(struct GPUBatch **batch);
187 bool DRW_batch_requested(struct GPUBatch *batch, int prim_type);
188 void DRW_ibo_request(struct GPUBatch *batch, struct GPUIndexBuf **ibo);
189 bool DRW_ibo_requested(struct GPUIndexBuf *ibo);
190 void DRW_vbo_request(struct GPUBatch *batch, struct GPUVertBuf **vbo);
191 bool DRW_vbo_requested(struct GPUVertBuf *vbo);
192
193 #endif /* __DRAW_CACHE_IMPL_H__ */