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

ImageLightingSamplesRun Class Reference

Precomputing run that computes environment lighting samples. More...

#include <ImageLightingSamplesRun.h>

Inheritance diagram for ImageLightingSamplesRun:

PreComputingRun RenderingRun List of all members.

Public Member Functions

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

Private Attributes

IBLDepthMapPass depthMapPass [4]
unsigned int depthMapSize
HdriSampler hdriSampler
unsigned int nSamplePoints

Detailed Description

Precomputing run that computes environment lighting samples.

Precomputing run that computes


Constructor & Destructor Documentation

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

Contructor.

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

~ImageBasedLightingModule  ) 
 

Destructor.


Member Function Documentation

const String& 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 getDepthMapSize  )  [inline]
 

Returns:
Depth map resolution.

unsigned int getNSamplePoints  )  [inline]
 

Returns:
Number of directional samples generated.

HdriSampler* getSamples  )  [inline]
 

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

void loadHdri const String &  environHdriPath  ) 
 

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

bool 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 rewind  ) 
 

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

void setNSamplePoints unsigned int  nSamplePoints  )  [inline]
 

Parameters:
nSamplePoints Number of directional samples to be generated.

void update  )  [virtual]
 

Inherited from PreComputingRun. Recomputes samples.

Implements PreComputingRun.


Member Data Documentation

IBLDepthMapPass depthMapPass[4] [private]
 

unsigned int depthMapSize [private]
 

Depth map resolution.

HdriSampler hdriSampler [private]
 

High Dynamic Range Image sampler. Contains sample data.

unsigned int nSamplePoints [private]
 

Number of directional samples generated.


The documentation for this class was generated from the following file:
Generated on Mon Apr 18 10:59:27 2005 for OGRE_IllumModule by  doxygen 1.4.2