Phx::GraphicsEngine::Light Class Reference

A light source used in the graphics engine. More...

#include <PhxGraphicsEngine.h>

Inheritance diagram for Phx::GraphicsEngine::Light:

List of all members.

Public Member Functions
virtual void	specular (const RgbaColor &specular)=0
	Sets the specular light color.
virtual RgbaColor	specular (void) const =0
	Gets the current specular light color.
virtual void	diffuse (const RgbaColor &diffuse)=0
	Sets the diffuse light reflectance.
virtual RgbaColor	diffuse (void) const =0
	Gets the current diffuse reflectance.
const String &	name (void) const
Protected Member Functions
void	setName (const String &name)

---

Detailed Description

A light source used in the graphics engine.

This is a base interface class for the other light source types.

---

Member Function Documentation

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

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

virtual void Phx::GraphicsEngine::Light::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 String& Phx::GraphicsEngine::Light::name (  void   )  const [inline]

Todo: Add Light attentuation and range

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

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

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

Sets the specular light color. This is the color of light that will contribute to specular highlights. 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

---