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