R2Fog.h File Reference

Types related to fog rendering. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	R2_fog_t
	The type of fog parameters. More...

Functions
float	R2_fogAmountLinear (const R2_fog_t fog, const float z)
float	R2_fogAmountQuadratic (const R2_fog_t fog, const float z)
float	R2_fogAmountQuadraticInverse (const R2_fog_t fog, const float z)
vec3	R2_fogLinear (const R2_fog_t fog, const vec3 surface, const float z)
vec3	R2_fogQuadratic (const R2_fog_t fog, const vec3 surface, const float z)
vec3	R2_fogQuadraticInverse (const R2_fog_t fog, const vec3 surface, const float z)

Detailed Description

Types related to fog rendering.

Definition in file R2Fog.h.

Function Documentation

R2_fogAmountLinear()

float R2_fogAmountLinear	(	const R2_fog_t	fog,
		const float	z
	)

Calculate the linear fog amount for the given positive eye-space Z value z.

Parameters

fog	Fog parameters
z	The positive eye-space Z value of the surface

Definition at line 28 of file R2Fog.h.

{
  return clamp((z - fog.z_near) / (fog.z_far - fog.z_near), 0.0, 1.0);
}

R2_fogAmountQuadratic()

float R2_fogAmountQuadratic	(	const R2_fog_t	fog,
		const float	z
	)

Calculate the quadratic fog amount for the given positive eye-space Z value z.

Parameters

fog	Fog parameters
z	The positive eye-space Z value of the surface

Definition at line 43 of file R2Fog.h.

{
  float linear = R2_fogAmountLinear(fog, z);
  return linear * linear;
}

R2_fogAmountQuadraticInverse()

float R2_fogAmountQuadraticInverse	(	const R2_fog_t	fog,
		const float	z
	)

Calculate the inverse quadratic fog amount for the given positive eye-space Z value z.

Parameters

fog	Fog parameters
z	The positive eye-space Z value of the surface

Definition at line 59 of file R2Fog.h.

{
  return sqrt(R2_fogAmountLinear(fog, z));
}

R2_fogLinear()

vec3 R2_fogLinear	(	const R2_fog_t	fog,
		const vec3	surface,
		const float	z
	)

Calculate linear fog for the given positive eye-space Z value z.

Parameters

fog	Fog parameters
surface	The current surface color
z	The positive eye-space Z value of the surface

Definition at line 75 of file R2Fog.h.

{
  return mix(surface, fog.color, R2_fogAmountLinear(fog, z));
}

R2_fogQuadratic()

vec3 R2_fogQuadratic	(	const R2_fog_t	fog,
		const vec3	surface,
		const float	z
	)

Calculate quadratic fog for the given positive eye-space Z value z.

Parameters

fog	Fog parameters
surface	The current surface color
z	The positive eye-space Z value of the surface

Definition at line 92 of file R2Fog.h.

{
  return mix(surface, fog.color, R2_fogAmountQuadratic(fog, z));
}

R2_fogQuadraticInverse()

vec3 R2_fogQuadraticInverse	(	const R2_fog_t	fog,
		const vec3	surface,
		const float	z
	)

Calculate inverse quadratic fog for the given positive eye-space Z value z.

Parameters

fog	Fog parameters
surface	The current surface color
z	The positive eye-space Z value of the surface

Definition at line 109 of file R2Fog.h.

{
  return mix(surface, fog.color, R2_fogAmountQuadraticInverse(fog, z));
}