lightlut.h File Reference

Generate lighting lookup tables. More...

#include "types.h"
#include <math.h>

Go to the source code of this file.

Data Structures
struct	C3D_LightLut
struct	C3D_LightLutDA

Macros
#define	LightLut_Phong(lut, shininess)   LightLut_FromFunc((lut), powf, (shininess), false)
	Generates lighting lookup table using powf function (phong lighting).
#define	LightLut_Spotlight(lut, angle)   LightLut_FromFunc((lut), spot_step, cosf(angle), true)
	Generates lighting lookup table for spotlights.
#define	LightLutDA_Quadratic(lut, from, to, linear, quad)   LightLutDA_Create((lut), quadratic_dist_attn, (from), (to), (linear), (quad))
	Generates distance attenuation lookup table.

Typedefs
typedef float(*	C3D_LightLutFunc) (float x, float param)
typedef float(*	C3D_LightLutFuncDA) (float dist, float arg0, float arg1)

Functions
static float	quadratic_dist_attn (float dist, float linear, float quad)
static float	spot_step (float angle, float cutoff)
void	LightLut_FromArray (C3D_LightLut *lut, float *data)
	Generates lighting lookup table from pre-computed float array.
void	LightLut_FromFunc (C3D_LightLut *lut, C3D_LightLutFunc func, float param, bool negative)
	Generates lighting lookup table using specified callback function.
void	LightLutDA_Create (C3D_LightLutDA *lut, C3D_LightLutFuncDA func, float from, float to, float arg0, float arg1)
	Generates distance attenuation lookup table using specified callback function.

Detailed Description

Generate lighting lookup tables.

Macro Definition Documentation

LightLut_Phong

#define LightLut_Phong	(		lut,
			shininess
	)		LightLut_FromFunc((lut), powf, (shininess), false)

Generates lighting lookup table using powf function (phong lighting).

Parameters

[out]	lut	Pointer to light environment structure.
[in]	shininess	Shininess value of specular highlights (pow function exponent).

LightLut_Spotlight

#define LightLut_Spotlight	(		lut,
			angle
	)		LightLut_FromFunc((lut), spot_step, cosf(angle), true)

Generates lighting lookup table for spotlights.

Parameters

[out]	lut	Pointer to light environment structure.
[in]	angle	Beam angle of the spotlight.

LightLutDA_Quadratic

#define LightLutDA_Quadratic	(		lut,
			from,
			to,
			linear,
			quad
	)		LightLutDA_Create((lut), quadratic_dist_attn, (from), (to), (linear), (quad))

Generates distance attenuation lookup table.

Parameters

[out]	lut	Pointer to light environment structure.
[in]	from	Minimum distance from light source.
[in]	to	Maximum distance from light source.
[in]	linear	Linear coefficient.
[in]	quad	Quadratic coefficient.

Function Documentation

LightLut_FromArray()

void LightLut_FromArray	(	C3D_LightLut *	lut,
		float *	data
	)

Generates lighting lookup table from pre-computed float array.

Parameters

[out]	lut	Pointer to lighting lookup table structure.
[in]	data	Pointer to pre-computed float array.

LightLut_FromFunc()

void LightLut_FromFunc	(	C3D_LightLut *	lut,
		C3D_LightLutFunc	func,
		float	param,
		bool	negative
	)

Generates lighting lookup table using specified callback function.

Parameters

[out]	lut	Pointer to light environment structure.
[in]	func	Callback function.
[in]	param	User-specified parameter to callback function.
[in]	negative	If false, x argument of callback function will be in range [0,256]. If true, x argument will be in range [-128,128].

LightLutDA_Create()

void LightLutDA_Create	(	C3D_LightLutDA *	lut,
		C3D_LightLutFuncDA	func,
		float	from,
		float	to,
		float	arg0,
		float	arg1
	)

Generates distance attenuation lookup table using specified callback function.

Parameters

[out]	lut	Pointer to light environment structure.
[in]	func	Callback function.
[in]	from	Starting distance of lighting.
[in]	to	Ending distance of lighting.
[in]	arg0	User-specified parameter to callback function.
[in]	arg1	User-specified parameter to callback function.