CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

iLightMap Struct Reference

The lightmap interface. More...

#include <lightmap.h>

Inheritance diagram for iLightMap:

iBase List of all members.

Public Methods

virtual csRGBpixelGetMapData ()=0
 Get light map data. More...

virtual int GetWidth ()=0
 Get lightmap width (could be adjusted to power of two). More...

virtual int GetHeight ()=0
 Get lightmap height (could be adjusted to power of two). More...

virtual int GetRealWidth ()=0
 Get real lightmap width (could be less than returned by GetWidth()). More...

virtual int GetRealHeight ()=0
 Get real lightmap height (could be less than returned by GetHeight()). More...

virtual void * GetCacheData ()=0
 Get data used internally by texture cache. More...

virtual void SetCacheData (void *d)=0
 Set data used internally by texture cache. More...

virtual void GetMeanLighting (int &r, int &g, int &b)=0
 Get mean color for the lightmaps. More...

virtual long GetSize ()=0
 Get size of one lightmap. More...


Detailed Description

The lightmap interface.

A lightmap is similar to a texture but contains just intensities, 256 levels from 0 to 255. This map is overlaid onto the texture to obtain darker or brighter portions of texture.

Definition at line 34 of file lightmap.h.


Member Function Documentation

virtual void* iLightMap::GetCacheData   [pure virtual]
 

Get data used internally by texture cache.

virtual int iLightMap::GetHeight   [pure virtual]
 

Get lightmap height (could be adjusted to power of two).

virtual csRGBpixel* iLightMap::GetMapData   [pure virtual]
 

Get light map data.

virtual void iLightMap::GetMeanLighting int &    r,
int &    g,
int &    b
[pure virtual]
 

Get mean color for the lightmaps.

virtual int iLightMap::GetRealHeight   [pure virtual]
 

Get real lightmap height (could be less than returned by GetHeight()).

virtual int iLightMap::GetRealWidth   [pure virtual]
 

Get real lightmap width (could be less than returned by GetWidth()).

virtual long iLightMap::GetSize   [pure virtual]
 

Get size of one lightmap.

virtual int iLightMap::GetWidth   [pure virtual]
 

Get lightmap width (could be adjusted to power of two).

virtual void iLightMap::SetCacheData void *    d [pure virtual]
 

Set data used internally by texture cache.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14