R2LightDirectional.h File Reference

Functions and types related to directional lighting. More...

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

Go to the source code of this file.

Data Structures
struct	R2_light_directional_vectors_t
	Vectors used when calculating directional lighting. More...
struct	R2_light_directional_t
	A directional light type. More...

Functions
R2_light_directional_vectors_t	R2_lightDirectionalVectors (const R2_light_directional_t light, const vec3 p, const vec3 n)
vec3	R2_lightDirectionalDiffuseTerm (const R2_light_directional_t light, const R2_light_directional_vectors_t v)
vec3	R2_lightDirectionalSpecularTerm (const R2_light_directional_t light, const R2_light_directional_vectors_t v, const vec3 specular_color, const float specular_exponent)

Detailed Description

Functions and types related to directional lighting.

Definition in file R2LightDirectional.h.

Function Documentation

R2_lightDirectionalDiffuseTerm()

vec3 R2_lightDirectionalDiffuseTerm	(	const R2_light_directional_t	light,
		const R2_light_directional_vectors_t	v
	)

Calculate the diffuse term for a directional light.

Parameters

light	The light parameters
v	The calculated light vectors

Returns

The diffuse term

Definition at line 59 of file R2LightDirectional.h.

{
  float factor = max (0.0, dot (v.surface_to_light, v.normal));
  return (light.color * light.intensity) * factor;
}

R2_lightDirectionalSpecularTerm()

vec3 R2_lightDirectionalSpecularTerm	(	const R2_light_directional_t	light,
		const R2_light_directional_vectors_t	v,
		const vec3	specular_color,
		const float	specular_exponent
	)

Calculate the specular term for a directional light

Parameters

light	The light parameters
v	The calculated light vectors
specular_color	The surface specular color
specular_exponent	The surface specular exponent

Returns

The specular term

Definition at line 77 of file R2LightDirectional.h.

{
  float base_factor =
    max (0.0, dot (v.reflection, v.surface_to_light));
  float factor =
    pow (base_factor, specular_exponent);
  vec3 color =
    (light.color * light.intensity) * factor;
  return color * specular_color;
}

R2_lightDirectionalVectors()

R2_light_directional_vectors_t R2_lightDirectionalVectors	(	const R2_light_directional_t	light,
		const vec3	p,
		const vec3	n
	)

Calculate the vectors required to calculate directional lighting.

Parameters

light	The light parameters
p	The surface position
n	The surface normal

Returns

A set of lighting vectors

Definition at line 40 of file R2LightDirectional.h.

{
  vec3 observer_to_surface = normalize (p);
  vec3 surface_to_light    = normalize (-light.direction);
  vec3 reflection          = reflect (observer_to_surface, n);
  return R2_light_directional_vectors_t (observer_to_surface, surface_to_light, n, reflection);
}