ES3D::Lightx Class Reference

#include <Lightx.h>

List of all members.

Public Member Functions
	Lightx ()
virtual	~Lightx ()
GLboolean	activatex (GLvoid)
GLvoid	resetx (GLvoid)
ES3Denum	setPositionDirectionx (ES3Denum type, FixedPointx posDir[3])
GLvoid	getPositionx (FixedPointx currentPosition[4])
GLvoid	getAttenuationx (FixedPointx currentAttenuation[3])
GLenum	getLightNumberx (GLvoid)
Static Public Member Functions
static Lightx *	getLightx (GLenum light)
Public Attributes
Spotx	spot
GLboolean	enableSpot
FixedPointx	ambient [4]
FixedPointx	diffuse [4]
FixedPointx	specular [4]
FixedPointx	emission [4]
Classes
class	Spotx

---

Detailed Description

Light class which encapsulates one OpenGL ES light

---

Constructor & Destructor Documentation

ES3D::Lightx::Lightx

(

)

Constructor

ES3D::Lightx::~Lightx

(

)

[virtual]

Destructor

---

Member Function Documentation

GLboolean ES3D::Lightx::activatex

(

GLvoid

)

Enables, activates the light. Tries to aquire a light. Updates all parameters.

Returns:

returns true on success; false, if no lights are left

GLvoid ES3D::Lightx::getAttenuationx

(

FixedPointx

currentAttenuation[3]

)

Rerieves and returns the current attenuation of the light

Parameters:

currentAttenuation

the array to store the attenuations

GLenum ES3D::Lightx::getLightNumberx

(

GLvoid

)

Returns the light number used by this light. Returns GL_MAX_LIGHTS if no one is associated to it.

Returns:

the light number

Lightx * ES3D::Lightx::getLightx

(

GLenum

light

)

[static]

Returns the light, if one exists.

Parameters:

light

the light to return

Returns:

pointer to the default light

GLvoid ES3D::Lightx::getPositionx

(

FixedPointx

currentPosition[4]

)

Retrieves and returns the current position (and type) of the light.

Parameters:

currentPosition

the array to store the position.

GLvoid ES3D::Lightx::resetx

(

GLvoid

)

Disables the light. Frees the resource.

ES3Denum ES3D::Lightx::setPositionDirectionx	(	ES3Denum	type,
		FixedPointx	posDir[3]
	)

Sets the position or direction of the light

Parameters:

	type	positional or directional light
	posDir	the position or direction of the light

Returns:

no error on success

---

Member Data Documentation

FixedPointx ES3D::Lightx::ambient[4]

Ambient light.

FixedPointx ES3D::Lightx::diffuse[4]

Diffuse light.

FixedPointx ES3D::Lightx::emission[4]

Emission light.

GLboolean ES3D::Lightx::enableSpot

Flag, if spot is enabled

FixedPointx ES3D::Lightx::specular[4]

Specular light.

Spotx ES3D::Lightx::spot

The spot light, if needed.

---

The documentation for this class was generated from the following files:

• C:/Projects/win32/ES3D/ES3D/Lightx.h
• C:/Projects/win32/ES3D/ES3D/Lightx.cpp

---