1 /*
2 Copyright (C) 1996-2001 Id Software, Inc.
3 Copyright (C) 2002-2009 John Fitzgibbons and others
4 Copyright (C) 2007-2008 Kristian Duske
5 Copyright (C) 2010-2014 QuakeSpasm developers
6 
7 This program is free software; you can redistribute it and/or
8 modify it under the terms of the GNU General Public License
9 as published by the Free Software Foundation; either version 2
10 of the License, or (at your option) any later version.
11 
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15 
16 See the GNU General Public License for more details.
17 
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21 */
22 //gl_fog.c -- global and volumetric fog
23 
24 #include "quakedef.h"
25 
26 //==============================================================================
27 //
28 //  GLOBAL FOG
29 //
30 //==============================================================================
31 
32 #define DEFAULT_DENSITY 0.0
33 #define DEFAULT_GRAY 0.3
34 
35 float fog_density;
36 float fog_red;
37 float fog_green;
38 float fog_blue;
39 
40 float old_density;
41 float old_red;
42 float old_green;
43 float old_blue;
44 
45 float fade_time; //duration of fade
46 float fade_done; //time when fade will be done
47 
48 /*
49 =============
50 Fog_Update
51 
52 update internal variables
53 =============
54 */
Fog_Update(float density,float red,float green,float blue,float time)55 void Fog_Update (float density, float red, float green, float blue, float time)
56 {
57 	//save previous settings for fade
58 	if (time > 0)
59 	{
60 		//check for a fade in progress
61 		if (fade_done > cl.time)
62 		{
63 			float f;
64 
65 			f = (fade_done - cl.time) / fade_time;
66 			old_density = f * old_density + (1.0 - f) * fog_density;
67 			old_red = f * old_red + (1.0 - f) * fog_red;
68 			old_green = f * old_green + (1.0 - f) * fog_green;
69 			old_blue = f * old_blue + (1.0 - f) * fog_blue;
70 		}
71 		else
72 		{
73 			old_density = fog_density;
74 			old_red = fog_red;
75 			old_green = fog_green;
76 			old_blue = fog_blue;
77 		}
78 	}
79 
80 	fog_density = density;
81 	fog_red = red;
82 	fog_green = green;
83 	fog_blue = blue;
84 	fade_time = time;
85 	fade_done = cl.time + time;
86 }
87 
88 /*
89 =============
90 Fog_ParseServerMessage
91 
92 handle an SVC_FOG message from server
93 =============
94 */
Fog_ParseServerMessage(void)95 void Fog_ParseServerMessage (void)
96 {
97 	float density, red, green, blue, time;
98 
99 	density = MSG_ReadByte() / 255.0;
100 	red = MSG_ReadByte() / 255.0;
101 	green = MSG_ReadByte() / 255.0;
102 	blue = MSG_ReadByte() / 255.0;
103 	time = q_max(0.0, MSG_ReadShort() / 100.0);
104 
105 	Fog_Update (density, red, green, blue, time);
106 }
107 
108 /*
109 =============
110 Fog_FogCommand_f
111 
112 handle the 'fog' console command
113 =============
114 */
Fog_FogCommand_f(void)115 void Fog_FogCommand_f (void)
116 {
117 	switch (Cmd_Argc())
118 	{
119 	default:
120 	case 1:
121 		Con_Printf("usage:\n");
122 		Con_Printf("   fog <density>\n");
123 		Con_Printf("   fog <red> <green> <blue>\n");
124 		Con_Printf("   fog <density> <red> <green> <blue>\n");
125 		Con_Printf("current values:\n");
126 		Con_Printf("   \"density\" is \"%f\"\n", fog_density);
127 		Con_Printf("   \"red\" is \"%f\"\n", fog_red);
128 		Con_Printf("   \"green\" is \"%f\"\n", fog_green);
129 		Con_Printf("   \"blue\" is \"%f\"\n", fog_blue);
130 		break;
131 	case 2:
132 		Fog_Update(q_max(0.0, atof(Cmd_Argv(1))),
133 				   fog_red,
134 				   fog_green,
135 				   fog_blue,
136 				   0.0);
137 		break;
138 	case 3: //TEST
139 		Fog_Update(q_max(0.0, atof(Cmd_Argv(1))),
140 				   fog_red,
141 				   fog_green,
142 				   fog_blue,
143 				   atof(Cmd_Argv(2)));
144 		break;
145 	case 4:
146 		Fog_Update(fog_density,
147 				   CLAMP(0.0, atof(Cmd_Argv(1)), 1.0),
148 				   CLAMP(0.0, atof(Cmd_Argv(2)), 1.0),
149 				   CLAMP(0.0, atof(Cmd_Argv(3)), 1.0),
150 				   0.0);
151 		break;
152 	case 5:
153 		Fog_Update(q_max(0.0, atof(Cmd_Argv(1))),
154 				   CLAMP(0.0, atof(Cmd_Argv(2)), 1.0),
155 				   CLAMP(0.0, atof(Cmd_Argv(3)), 1.0),
156 				   CLAMP(0.0, atof(Cmd_Argv(4)), 1.0),
157 				   0.0);
158 		break;
159 	case 6: //TEST
160 		Fog_Update(q_max(0.0, atof(Cmd_Argv(1))),
161 				   CLAMP(0.0, atof(Cmd_Argv(2)), 1.0),
162 				   CLAMP(0.0, atof(Cmd_Argv(3)), 1.0),
163 				   CLAMP(0.0, atof(Cmd_Argv(4)), 1.0),
164 				   atof(Cmd_Argv(5)));
165 		break;
166 	}
167 }
168 
169 /*
170 =============
171 Fog_ParseWorldspawn
172 
173 called at map load
174 =============
175 */
Fog_ParseWorldspawn(void)176 void Fog_ParseWorldspawn (void)
177 {
178 	char key[128], value[4096];
179 	const char *data;
180 
181 	//initially no fog
182 	fog_density = DEFAULT_DENSITY;
183 	fog_red = DEFAULT_GRAY;
184 	fog_green = DEFAULT_GRAY;
185 	fog_blue = DEFAULT_GRAY;
186 
187 	old_density = DEFAULT_DENSITY;
188 	old_red = DEFAULT_GRAY;
189 	old_green = DEFAULT_GRAY;
190 	old_blue = DEFAULT_GRAY;
191 
192 	fade_time = 0.0;
193 	fade_done = 0.0;
194 
195 	data = COM_Parse(cl.worldmodel->entities);
196 	if (!data)
197 		return; // error
198 	if (com_token[0] != '{')
199 		return; // error
200 	while (1)
201 	{
202 		data = COM_Parse(data);
203 		if (!data)
204 			return; // error
205 		if (com_token[0] == '}')
206 			break; // end of worldspawn
207 		if (com_token[0] == '_')
208 			q_strlcpy(key, com_token + 1, sizeof(key));
209 		else
210 			q_strlcpy(key, com_token, sizeof(key));
211 		while (key[0] && key[strlen(key)-1] == ' ') // remove trailing spaces
212 			key[strlen(key)-1] = 0;
213 		data = COM_Parse(data);
214 		if (!data)
215 			return; // error
216 		q_strlcpy(value, com_token, sizeof(value));
217 
218 		if (!strcmp("fog", key))
219 		{
220 			sscanf(value, "%f %f %f %f", &fog_density, &fog_red, &fog_green, &fog_blue);
221 		}
222 	}
223 }
224 
225 /*
226 =============
227 Fog_GetColor
228 
229 calculates fog color for this frame, taking into account fade times
230 =============
231 */
Fog_GetColor(void)232 float *Fog_GetColor (void)
233 {
234 	static float c[4];
235 	float f;
236 	int i;
237 
238 	if (fade_done > cl.time)
239 	{
240 		f = (fade_done - cl.time) / fade_time;
241 		c[0] = f * old_red + (1.0 - f) * fog_red;
242 		c[1] = f * old_green + (1.0 - f) * fog_green;
243 		c[2] = f * old_blue + (1.0 - f) * fog_blue;
244 		c[3] = 1.0;
245 	}
246 	else
247 	{
248 		c[0] = fog_red;
249 		c[1] = fog_green;
250 		c[2] = fog_blue;
251 		c[3] = 1.0;
252 	}
253 
254 	//find closest 24-bit RGB value, so solid-colored sky can match the fog perfectly
255 	for (i=0;i<3;i++)
256 		c[i] = (float)(Q_rint(c[i] * 255)) / 255.0f;
257 
258 	return c;
259 }
260 
261 /*
262 =============
263 Fog_GetDensity
264 
265 returns current density of fog
266 =============
267 */
Fog_GetDensity(void)268 float Fog_GetDensity (void)
269 {
270 	float f;
271 
272 	if (fade_done > cl.time)
273 	{
274 		f = (fade_done - cl.time) / fade_time;
275 		return f * old_density + (1.0 - f) * fog_density;
276 	}
277 	else
278 		return fog_density;
279 }
280 
281 /*
282 =============
283 Fog_SetupFrame
284 
285 called at the beginning of each frame
286 =============
287 */
Fog_SetupFrame(void)288 void Fog_SetupFrame (void)
289 {
290 	float * fog_color = Fog_GetColor();
291 	float fog_values[4] = { CLAMP( 0.0f, fog_color[0], 1.0f ), CLAMP(0.0f, fog_color[1], 1.0f), CLAMP(0.0f, fog_color[2], 1.0f), Fog_GetDensity() / 64.0f };
292 	R_PushConstants(VK_SHADER_STAGE_ALL_GRAPHICS, 16 * sizeof(float), 4 * sizeof(float), fog_values);
293 }
294 
295 /*
296 =============
297 Fog_EnableGFog
298 
299 called before drawing stuff that should be fogged
300 =============
301 */
Fog_EnableGFog(void)302 void Fog_EnableGFog (void)
303 {
304 	float * fog_color = Fog_GetColor();
305 	float fog_values[4] = { CLAMP( 0.0f, fog_color[0], 1.0f ), CLAMP(0.0f, fog_color[1], 1.0f), CLAMP(0.0f, fog_color[2], 1.0f), Fog_GetDensity() / 64.0f };
306 	R_PushConstants(VK_SHADER_STAGE_ALL_GRAPHICS, 16 * sizeof(float), 4 * sizeof(float), fog_values);
307 }
308 
309 /*
310 =============
311 Fog_DisableGFog
312 
313 called after drawing stuff that should be fogged
314 =============
315 */
Fog_DisableGFog(void)316 void Fog_DisableGFog (void)
317 {
318 	float fog_values[4] = { 0.0f, 0.0f, 0.0f, 0.0f };
319 	assert(vulkan_globals.current_pipeline.layout.handle == vulkan_globals.basic_pipeline_layout.handle);
320 	R_PushConstants(VK_SHADER_STAGE_ALL_GRAPHICS, 16 * sizeof(float), 4 * sizeof(float), fog_values);
321 }
322 
323 //==============================================================================
324 //
325 //  VOLUMETRIC FOG
326 //
327 //==============================================================================
328 
329 cvar_t r_vfog = {"r_vfog", "1", CVAR_NONE};
330 
Fog_DrawVFog(void)331 void Fog_DrawVFog (void){}
Fog_MarkModels(void)332 void Fog_MarkModels (void){}
333 
334 //==============================================================================
335 //
336 //  INIT
337 //
338 //==============================================================================
339 
340 /*
341 =============
342 Fog_NewMap
343 
344 called whenever a map is loaded
345 =============
346 */
Fog_NewMap(void)347 void Fog_NewMap (void)
348 {
349 	Fog_ParseWorldspawn (); //for global fog
350 	Fog_MarkModels (); //for volumetric fog
351 }
352 
353 /*
354 =============
355 Fog_Init
356 
357 called when quake initializes
358 =============
359 */
Fog_Init(void)360 void Fog_Init (void)
361 {
362 	Cmd_AddCommand ("fog",Fog_FogCommand_f);
363 
364 	//Cvar_RegisterVariable (&r_vfog);
365 
366 	//set up global fog
367 	fog_density = DEFAULT_DENSITY;
368 	fog_red = DEFAULT_GRAY;
369 	fog_green = DEFAULT_GRAY;
370 	fog_blue = DEFAULT_GRAY;
371 }
372