Cleanup: blank lines over doxy headers
[blender.git] / source / blender / draw / intern / draw_cache.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.h
26  *  \ingroup draw
27  */
28
29 #ifndef __DRAW_CACHE_H__
30 #define __DRAW_CACHE_H__
31
32 struct GPUBatch;
33 struct GPUMaterial;
34 struct ModifierData;
35 struct Object;
36 struct PTCacheEdit;
37
38 void DRW_shape_cache_free(void);
39 void DRW_shape_cache_reset(void);
40
41 /* 3D cursor */
42 struct GPUBatch *DRW_cache_cursor_get(bool crosshair_lines);
43
44 /* Common Shapes */
45 struct GPUBatch *DRW_cache_grid_get(void);
46 struct GPUBatch *DRW_cache_fullscreen_quad_get(void);
47 struct GPUBatch *DRW_cache_quad_get(void);
48 struct GPUBatch *DRW_cache_cube_get(void);
49 struct GPUBatch *DRW_cache_sphere_get(void);
50 struct GPUBatch *DRW_cache_single_vert_get(void);
51 struct GPUBatch *DRW_cache_single_line_get(void);
52 struct GPUBatch *DRW_cache_single_line_endpoints_get(void);
53 struct GPUBatch *DRW_cache_screenspace_circle_get(void);
54
55 /* Common Object */
56 struct GPUBatch *DRW_cache_object_all_edges_get(struct Object *ob);
57 struct GPUBatch *DRW_cache_object_edge_detection_get(struct Object *ob, bool *r_is_manifold);
58 struct GPUBatch *DRW_cache_object_surface_get(struct Object *ob);
59 struct GPUBatch *DRW_cache_object_loose_edges_get(struct Object *ob);
60 struct GPUBatch **DRW_cache_object_surface_material_get(
61         struct Object *ob, struct GPUMaterial **gpumat_array, uint gpumat_array_len,
62         char **auto_layer_names, int **auto_layer_is_srgb, int *auto_layer_count);
63 struct GPUBatch *DRW_cache_object_face_wireframe_get(Object *ob);
64
65 /* Empties */
66 struct GPUBatch *DRW_cache_plain_axes_get(void);
67 struct GPUBatch *DRW_cache_single_arrow_get(void);
68 struct GPUBatch *DRW_cache_empty_cube_get(void);
69 struct GPUBatch *DRW_cache_circle_get(void);
70 struct GPUBatch *DRW_cache_square_get(void);
71 struct GPUBatch *DRW_cache_empty_sphere_get(void);
72 struct GPUBatch *DRW_cache_empty_cylinder_get(void);
73 struct GPUBatch *DRW_cache_empty_cone_get(void);
74 struct GPUBatch *DRW_cache_empty_capsule_cap_get(void);
75 struct GPUBatch *DRW_cache_empty_capsule_body_get(void);
76 struct GPUBatch *DRW_cache_image_plane_get(void);
77 struct GPUBatch *DRW_cache_image_plane_wire_get(void);
78
79 /* Force Field */
80 struct GPUBatch *DRW_cache_field_wind_get(void);
81 struct GPUBatch *DRW_cache_field_force_get(void);
82 struct GPUBatch *DRW_cache_field_vortex_get(void);
83 struct GPUBatch *DRW_cache_field_tube_limit_get(void);
84 struct GPUBatch *DRW_cache_field_cone_limit_get(void);
85
86 /* Grease Pencil */
87 struct GPUBatch *DRW_cache_gpencil_axes_get(void);
88
89 /* Lamps */
90 struct GPUBatch *DRW_cache_lamp_get(void);
91 struct GPUBatch *DRW_cache_lamp_shadows_get(void);
92 struct GPUBatch *DRW_cache_lamp_sunrays_get(void);
93 struct GPUBatch *DRW_cache_lamp_area_square_get(void);
94 struct GPUBatch *DRW_cache_lamp_area_disk_get(void);
95 struct GPUBatch *DRW_cache_lamp_hemi_get(void);
96 struct GPUBatch *DRW_cache_lamp_spot_get(void);
97 struct GPUBatch *DRW_cache_lamp_spot_volume_get(void);
98 struct GPUBatch *DRW_cache_lamp_spot_square_get(void);
99 struct GPUBatch *DRW_cache_lamp_spot_square_volume_get(void);
100
101 /* Camera */
102 struct GPUBatch *DRW_cache_camera_get(void);
103 struct GPUBatch *DRW_cache_camera_frame_get(void);
104 struct GPUBatch *DRW_cache_camera_tria_get(void);
105
106 /* Speaker */
107 struct GPUBatch *DRW_cache_speaker_get(void);
108
109 /* Probe */
110 struct GPUBatch *DRW_cache_lightprobe_cube_get(void);
111 struct GPUBatch *DRW_cache_lightprobe_grid_get(void);
112 struct GPUBatch *DRW_cache_lightprobe_planar_get(void);
113
114 /* Bones */
115 struct GPUBatch *DRW_cache_bone_octahedral_get(void);
116 struct GPUBatch *DRW_cache_bone_octahedral_wire_get(void);
117 struct GPUBatch *DRW_cache_bone_box_get(void);
118 struct GPUBatch *DRW_cache_bone_box_wire_get(void);
119 struct GPUBatch *DRW_cache_bone_envelope_solid_get(void);
120 struct GPUBatch *DRW_cache_bone_envelope_outline_get(void);
121 struct GPUBatch *DRW_cache_bone_point_get(void);
122 struct GPUBatch *DRW_cache_bone_point_wire_outline_get(void);
123 struct GPUBatch *DRW_cache_bone_stick_get(void);
124 struct GPUBatch *DRW_cache_bone_arrows_get(void);
125 struct GPUBatch *DRW_cache_bone_dof_sphere_get(void);
126 struct GPUBatch *DRW_cache_bone_dof_lines_get(void);
127
128 /* Meshes */
129 struct GPUBatch *DRW_cache_mesh_all_verts_get(struct Object *ob);
130 struct GPUBatch *DRW_cache_mesh_all_edges_get(struct Object *ob);
131 struct GPUBatch *DRW_cache_mesh_loose_edges_get(struct Object *ob);
132 struct GPUBatch *DRW_cache_mesh_edge_detection_get(struct Object *ob, bool *r_is_manifold);
133 struct GPUBatch *DRW_cache_mesh_surface_get(struct Object *ob);
134 struct GPUBatch *DRW_cache_mesh_surface_edges_get(struct Object *ob);
135 struct GPUBatch **DRW_cache_mesh_surface_shaded_get(
136         struct Object *ob, struct GPUMaterial **gpumat_array, uint gpumat_array_len,
137         char **auto_layer_names, int **auto_layer_is_srgb, int *auto_layer_count);
138 struct GPUBatch **DRW_cache_mesh_surface_texpaint_get(struct Object *ob);
139 struct GPUBatch *DRW_cache_mesh_surface_texpaint_single_get(struct Object *ob);
140 struct GPUBatch *DRW_cache_mesh_surface_vertpaint_get(struct Object *ob);
141 struct GPUBatch *DRW_cache_mesh_surface_weights_get(struct Object *ob);
142 struct GPUBatch *DRW_cache_mesh_face_wireframe_get(struct Object *ob);
143
144 void DRW_cache_mesh_sculpt_coords_ensure(struct Object *ob);
145
146 /* Curve */
147 struct GPUBatch *DRW_cache_curve_surface_get(struct Object *ob);
148 struct GPUBatch **DRW_cache_curve_surface_shaded_get(
149         struct Object *ob, struct GPUMaterial **gpumat_array, uint gpumat_array_len);
150 struct GPUBatch *DRW_cache_curve_loose_edges_get(struct Object *ob);
151 struct GPUBatch *DRW_cache_curve_edge_wire_get(struct Object *ob);
152 struct GPUBatch *DRW_cache_curve_face_wireframe_get(Object *ob);
153 /* edit-mode */
154 struct GPUBatch *DRW_cache_curve_edge_normal_get(struct Object *ob);
155 struct GPUBatch *DRW_cache_curve_edge_overlay_get(struct Object *ob);
156 struct GPUBatch *DRW_cache_curve_vert_overlay_get(struct Object *ob, bool handles);
157
158 /* Font */
159 struct GPUBatch *DRW_cache_text_surface_get(struct Object *ob);
160 struct GPUBatch *DRW_cache_text_loose_edges_get(struct Object *ob);
161 struct GPUBatch *DRW_cache_text_edge_wire_get(struct Object *ob);
162 struct GPUBatch **DRW_cache_text_surface_shaded_get(
163         struct Object *ob, struct GPUMaterial **gpumat_array, uint gpumat_array_len);
164 struct GPUBatch *DRW_cache_text_face_wireframe_get(Object *ob);
165
166 /* Surface */
167 struct GPUBatch *DRW_cache_surf_surface_get(struct Object *ob);
168 struct GPUBatch *DRW_cache_surf_edge_wire_get(struct Object *ob);
169 struct GPUBatch *DRW_cache_surf_loose_edges_get(struct Object *ob);
170 struct GPUBatch **DRW_cache_surf_surface_shaded_get(
171         struct Object *ob, struct GPUMaterial **gpumat_array, uint gpumat_array_len);
172 struct GPUBatch *DRW_cache_surf_face_wireframe_get(Object *ob);
173
174 /* Lattice */
175 struct GPUBatch *DRW_cache_lattice_verts_get(struct Object *ob);
176 struct GPUBatch *DRW_cache_lattice_wire_get(struct Object *ob, bool use_weight);
177 struct GPUBatch *DRW_cache_lattice_vert_overlay_get(struct Object *ob);
178
179 /* Particles */
180 struct GPUBatch *DRW_cache_particles_get_hair(
181         struct Object *object, struct ParticleSystem *psys, struct ModifierData *md);
182 struct GPUBatch *DRW_cache_particles_get_dots(
183         struct Object *object, struct ParticleSystem *psys);
184 struct GPUBatch *DRW_cache_particles_get_edit_strands(
185         struct Object *object, struct ParticleSystem *psys, struct PTCacheEdit *edit, bool use_weight);
186 struct GPUBatch *DRW_cache_particles_get_edit_inner_points(
187         struct Object *object, struct ParticleSystem *psys, struct PTCacheEdit *edit);
188 struct GPUBatch *DRW_cache_particles_get_edit_tip_points(
189         struct Object *object, struct ParticleSystem *psys, struct PTCacheEdit *edit);
190 struct GPUBatch *DRW_cache_particles_get_prim(int type);
191
192 /* Metaball */
193 struct GPUBatch *DRW_cache_mball_surface_get(struct Object *ob);
194 struct GPUBatch **DRW_cache_mball_surface_shaded_get(struct Object *ob, struct GPUMaterial **gpumat_array, uint gpumat_array_len);
195 struct GPUBatch *DRW_cache_mball_face_wireframe_get(Object *ob);
196
197 #endif /* __DRAW_CACHE_H__ */