Phx::GraphicsEngine::LightDescription Class Reference

A description of a light source in the graphics engine. More...

#include <PhxGraphicsEngine.h>

Inheritance diagram for Phx::GraphicsEngine::LightDescription:

List of all members.

Public Member Functions
virtual void	specular (const RgbaColor &specular)=0
	Sets the specular light color.
const RgbaColor &	specular (void) const
	Gets the current specular light color.
virtual void	ambient (const RgbaColor &ambient)=0
	Sets the ambient light emission.
const RgbaColor &	ambient (void) const
	Gets the current ambient light emission.
virtual void	diffuse (const RgbaColor &diffuse)=0
	Sets the diffuse light reflectance.
const RgbaColor &	diffuse (void) const
	Gets the current diffuse reflectance.
Protected Member Functions
void	setDiffuse (const RgbaColor &c)
void	setAmbient (const RgbaColor &c)
void	setSpecular (const RgbaColor &c)

---

Detailed Description

A description of a light source in the graphics engine.

---

Member Function Documentation

const RgbaColor& Phx::GraphicsEngine::LightDescription::ambient (  void   )  const [inline]

Gets the current ambient light emission. Returns: The amount of each color component of ambient light that is reflected.

virtual void Phx::GraphicsEngine::LightDescription::ambient (  const RgbaColor &  ambient  )  [pure virtual]

Sets the ambient light emission. Parameters: ambient  The amount of each color component that this light contributes to the ambient light of the nearby objects.

const RgbaColor& Phx::GraphicsEngine::LightDescription::diffuse (  void   )  const [inline]

Gets the current diffuse reflectance. Returns: The amount of each color component of diffuse light that is reflected.

virtual void Phx::GraphicsEngine::LightDescription::diffuse (  const RgbaColor &  diffuse  )  [pure virtual]

Sets the diffuse light reflectance. The amount of diffuse light reflected from a surface is related to its angle relative to the light source. Parameters: diffuse  The amount of each color component of diffuse light that is reflected.

const RgbaColor& Phx::GraphicsEngine::LightDescription::specular (  void   )  const [inline]

Gets the current specular light color. Returns: The amount of each specular light color component.

virtual void Phx::GraphicsEngine::LightDescription::specular (  const RgbaColor &  specular  )  [pure virtual]

Sets the specular light color. This is the color of light that will contribute to specular highlights. See MaterialDescription::specular(). Parameters: specular  The amount of each color component of specular light that the light source will emit.

---

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

• PhxGraphicsEngine.h

---