Main Page | Class Hierarchy | Class List | Directories | Class Members

ImageLightingSamplesRun Class Reference

#include <ImageLightingSamplesRun.h>

Inheritance diagram for ImageLightingSamplesRun:

PreComputingRun RenderingRun List of all members.

Public Member Functions

 ImageLightingSamplesRun (unsigned int depthMapSize, const String &environHdriPath, unsigned int nSamplePoints)
 Contructor.
 ~ImageBasedLightingModule ()
 Destructor.
unsigned int getDepthMapSize ()
unsigned int getNSamplePoints ()
void setNSamplePoints (unsigned int nSamplePoints)
void loadHdri (const String &environHdriPath)
void update ()
void rewind ()
bool renderNextDepthMaps ()
HdriSampler * getSamples ()
const String & getDepthMap (unsigned int index)

Detailed Description

Precomputing run that computes


Constructor & Destructor Documentation

ImageLightingSamplesRun::ImageLightingSamplesRun unsigned int  depthMapSize,
const String &  environHdriPath,
unsigned int  nSamplePoints
 

Contructor.

Parameters:
environHdriPath Path to the High Dynamic Range Image file used for illumination.
nSamplePoints Number of directional samples to be generated.


Member Function Documentation

const String& ImageLightingSamplesRun::getDepthMap unsigned int  index  )  [inline]
 

Parameters:
index The index of the depth map texture to be retrieved. There are 4 textures. renderNextDepthMaps will update them with the next 4 values.
Returns:
The depth map texture specified by index (0..3).

unsigned int ImageLightingSamplesRun::getDepthMapSize  )  [inline]
 

Returns:
Depth map resolution.

unsigned int ImageLightingSamplesRun::getNSamplePoints  )  [inline]
 

Returns:
Number of directional samples generated.

HdriSampler* ImageLightingSamplesRun::getSamples  )  [inline]
 

Returns:
The High Dynamic Range Image sampler holding the directional samples.

void ImageLightingSamplesRun::loadHdri const String &  environHdriPath  ) 
 

Parameters:
environHdriPath Path to the High Dynamic Range Image file used for illumination.

bool ImageLightingSamplesRun::renderNextDepthMaps  ) 
 

Render depth maps of next quadruple of samples into by depthsMapPass[0..3].

Returns:
true if successful, false if no samples are left.

void ImageLightingSamplesRun::rewind  ) 
 

Next renderNextDepthMaps will render the depth maps of the first quadruple of samples.

void ImageLightingSamplesRun::setNSamplePoints unsigned int  nSamplePoints  )  [inline]
 

Parameters:
nSamplePoints Number of directional samples to be generated.

void ImageLightingSamplesRun::update  )  [virtual]
 

Inherited from PreComputingRun. Recomputes samples.

Implements PreComputingRun.


The documentation for this class was generated from the following file:
Generated on Mon Apr 18 09:57:35 2005 for OGRE_IllumModule by  doxygen 1.4.2