Merge branch 'master' into blender2.8
[blender.git] / source / blender / draw / intern / draw_common.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_common.h
23  *  \ingroup draw
24  */
25
26 #ifndef __DRAW_COMMON_H__
27 #define __DRAW_COMMON_H__
28
29 struct DRWPass;
30 struct DRWShadingGroup;
31 struct GPUBatch;
32 struct GPUMaterial;
33 struct Object;
34 struct ViewLayer;
35 struct ModifierData;
36 struct ParticleSystem;
37 struct PTCacheEdit;
38
39 #define UBO_FIRST_COLOR colorWire
40 #define UBO_LAST_COLOR colorGridAxisZ
41
42 /* Used as ubo but colors can be directly referenced as well */
43 /* Keep in sync with: common_globals_lib.glsl (globalsBlock) */
44 /* NOTE! Also keep all color as vec4 and between UBO_FIRST_COLOR and UBO_LAST_COLOR */
45 typedef struct GlobalsUboStorage {
46         /* UBOs data needs to be 16 byte aligned (size of vec4) */
47         float colorWire[4];
48         float colorWireEdit[4];
49         float colorActive[4];
50         float colorSelect[4];
51         float colorTransform[4];
52         float colorLibrarySelect[4];
53         float colorLibrary[4];
54         float colorLamp[4];
55         float colorSpeaker[4];
56         float colorCamera[4];
57         float colorEmpty[4];
58         float colorVertex[4];
59         float colorVertexSelect[4];
60         float colorVertexUnreferenced[4];
61         float colorVertexMissingData[4];
62         float colorEditMeshActive[4];
63         float colorEdgeSelect[4];
64         float colorEdgeSeam[4];
65         float colorEdgeSharp[4];
66         float colorEdgeCrease[4];
67         float colorEdgeBWeight[4];
68         float colorEdgeFaceSelect[4];
69         float colorEdgeFreestyle[4];
70         float colorFace[4];
71         float colorFaceSelect[4];
72         float colorFaceFreestyle[4];
73         float colorNormal[4];
74         float colorVNormal[4];
75         float colorLNormal[4];
76         float colorFaceDot[4];
77
78         float colorDeselect[4];
79         float colorOutline[4];
80         float colorLampNoAlpha[4];
81
82         float colorBackground[4];
83
84         float colorHandleFree[4];
85         float colorHandleAuto[4];
86         float colorHandleVect[4];
87         float colorHandleAlign[4];
88         float colorHandleAutoclamp[4];
89         float colorHandleSelFree[4];
90         float colorHandleSelAuto[4];
91         float colorHandleSelVect[4];
92         float colorHandleSelAlign[4];
93         float colorHandleSelAutoclamp[4];
94         float colorNurbUline[4];
95         float colorNurbVline[4];
96         float colorNurbSelUline[4];
97         float colorNurbSelVline[4];
98         float colorActiveSpline[4];
99
100         float colorBonePose[4];
101
102         float colorCurrentFrame[4];
103
104         float colorGrid[4];
105         float colorGridEmphasise[4];
106         float colorGridAxisX[4];
107         float colorGridAxisY[4];
108         float colorGridAxisZ[4];
109
110         /* NOTE! Put all color before UBO_LAST_COLOR */
111
112         /* Pack individual float at the end of the buffer to avoid alignment errors */
113         float sizeLampCenter, sizeLampCircle, sizeLampCircleShadow;
114         float sizeVertex, sizeEdge, sizeEdgeFix, sizeFaceDot;
115         float gridDistance, gridResolution, gridSubdivisions, gridScale;
116
117         float pad_globalsBlock;
118 } GlobalsUboStorage;
119 /* Keep in sync with globalsBlock in shaders */
120 BLI_STATIC_ASSERT_ALIGN(GlobalsUboStorage, 16)
121
122 void DRW_globals_update(void);
123 void DRW_globals_free(void);
124
125 struct DRWShadingGroup *shgroup_dynlines_flat_color(struct DRWPass *pass);
126 struct DRWShadingGroup *shgroup_dynlines_dashed_uniform_color(struct DRWPass *pass, float color[4]);
127 struct DRWShadingGroup *shgroup_dynpoints_uniform_color(struct DRWPass *pass, float color[4], float *size);
128 struct DRWShadingGroup *shgroup_groundlines_uniform_color(struct DRWPass *pass, float color[4]);
129 struct DRWShadingGroup *shgroup_groundpoints_uniform_color(struct DRWPass *pass, float color[4]);
130 struct DRWShadingGroup *shgroup_instance_screenspace(struct DRWPass *pass, struct GPUBatch *geom, float *size);
131 struct DRWShadingGroup *shgroup_instance_solid(struct DRWPass *pass, struct GPUBatch *geom);
132 struct DRWShadingGroup *shgroup_instance_wire(struct DRWPass *pass, struct GPUBatch *geom);
133 struct DRWShadingGroup *shgroup_instance_screen_aligned(struct DRWPass *pass, struct GPUBatch *geom);
134 struct DRWShadingGroup *shgroup_instance_empty_axes(struct DRWPass *pass, struct GPUBatch *geom);
135 struct DRWShadingGroup *shgroup_instance_image_plane(struct DRWPass *pass, struct GPUBatch *geom);
136 struct DRWShadingGroup *shgroup_instance_scaled(struct DRWPass *pass, struct GPUBatch *geom);
137 struct DRWShadingGroup *shgroup_instance(struct DRWPass *pass, struct GPUBatch *geom);
138 struct DRWShadingGroup *shgroup_instance_alpha(struct DRWPass *pass, struct GPUBatch *geom, float alpha);
139 struct DRWShadingGroup *shgroup_instance_outline(struct DRWPass *pass, struct GPUBatch *geom, int *baseid);
140 struct DRWShadingGroup *shgroup_camera_instance(struct DRWPass *pass, struct GPUBatch *geom);
141 struct DRWShadingGroup *shgroup_distance_lines_instance(struct DRWPass *pass, struct GPUBatch *geom);
142 struct DRWShadingGroup *shgroup_spot_instance(struct DRWPass *pass, struct GPUBatch *geom);
143 struct DRWShadingGroup *shgroup_instance_mball_handles(struct DRWPass *pass);
144 struct DRWShadingGroup *shgroup_instance_bone_axes(struct DRWPass *pass);
145 struct DRWShadingGroup *shgroup_instance_bone_envelope_distance(struct DRWPass *pass);
146 struct DRWShadingGroup *shgroup_instance_bone_envelope_outline(struct DRWPass *pass);
147 struct DRWShadingGroup *shgroup_instance_bone_envelope_solid(struct DRWPass *pass, bool transp);
148 struct DRWShadingGroup *shgroup_instance_bone_shape_outline(struct DRWPass *pass, struct GPUBatch *geom);
149 struct DRWShadingGroup *shgroup_instance_bone_shape_solid(struct DRWPass *pass, struct GPUBatch *geom, bool transp);
150 struct DRWShadingGroup *shgroup_instance_bone_sphere_outline(struct DRWPass *pass);
151 struct DRWShadingGroup *shgroup_instance_bone_sphere_solid(struct DRWPass *pass, bool transp);
152 struct DRWShadingGroup *shgroup_instance_bone_stick(struct DRWPass *pass);
153 struct DRWShadingGroup *shgroup_instance_bone_dof(struct DRWPass *pass, struct GPUBatch *geom);
154
155 struct GPUShader *mpath_line_shader_get(void);
156 struct GPUShader *mpath_points_shader_get(void);
157
158 struct GPUShader *volume_velocity_shader_get(bool use_needle);
159
160 int DRW_object_wire_theme_get(
161         struct Object *ob, struct ViewLayer *view_layer, float **r_color);
162 float *DRW_color_background_blend_get(int theme_id);
163
164 bool DRW_object_is_flat(Object *ob, int *axis);
165 bool DRW_object_axis_orthogonal_to_view(Object *ob, int axis);
166
167 /* draw_armature.c */
168 typedef struct DRWArmaturePasses {
169         struct DRWPass *bone_solid;
170         struct DRWPass *bone_outline;
171         struct DRWPass *bone_wire;
172         struct DRWPass *bone_envelope;
173         struct DRWPass *bone_axes;
174         struct DRWPass *relationship_lines;
175 } DRWArmaturePasses;
176
177 void DRW_shgroup_armature_object(struct Object *ob, struct ViewLayer *view_layer, struct DRWArmaturePasses passes);
178 void DRW_shgroup_armature_pose(struct Object *ob, struct DRWArmaturePasses passes, bool transp);
179 void DRW_shgroup_armature_edit(struct Object *ob, struct DRWArmaturePasses passes, bool transp);
180
181 /* draw_hair.c */
182
183 /* This creates a shading group with display hairs.
184  * The draw call is already added by this function, just add additional uniforms. */
185 struct DRWShadingGroup *DRW_shgroup_hair_create(
186         struct Object *object, struct ParticleSystem *psys, struct ModifierData *md,
187         struct DRWPass *hair_pass,
188         struct GPUShader *shader);
189
190 struct DRWShadingGroup *DRW_shgroup_material_hair_create(
191         struct Object *object, struct ParticleSystem *psys, struct ModifierData *md,
192         struct DRWPass *hair_pass,
193         struct GPUMaterial *material);
194
195 void DRW_hair_init(void);
196 void DRW_hair_update(void);
197 void DRW_hair_free(void);
198
199 /* pose_mode.c */
200 bool DRW_pose_mode_armature(
201     struct Object *ob, struct Object *active_ob);
202
203 #endif /* __DRAW_COMMON_H__ */