Lightmetrica  0.0.1.50dbee3 (yosakoi)
 All Classes Functions Variables Typedefs Enumerations Enumerator
Public Member Functions | List of all members
Film Class Referenceabstract

#include <film.h>

Public Member Functions

 LM_ASSET_INTERFACE_DEF ("film","films")
 
 LM_ASSET_NO_DEPENDENCIES ()
 
virtual int Width () const =0
 
virtual int Height () const =0
 
virtual void RecordContribution (const Math::Vec2 &rasterPos, const Math::Vec3 &contrb)=0
 
virtual void AccumulateContribution (const Math::Vec2 &rasterPos, const Math::Vec3 &contrb)=0
 
virtual void AccumulateContribution (const Film &film)=0
 
virtual void Rescale (const Math::Float &weight)=0
 
virtual FilmClone () const =0
 
virtual void Clear ()=0
 
- Public Member Functions inherited from Asset
virtual bool Load (const ConfigNode &node, const Assets &assets)=0
 
LM_PUBLIC_API std::string ID () const
 
LM_HIDDEN_API void SetID (const std::string &id)
 
- Public Member Functions inherited from Component
virtual std::string ComponentInterfaceTypeName () const =0
 
virtual std::string ComponentImplTypeName () const =0
 
- Public Member Functions inherited from SIMDAlignedType
void * operator new (std::size_t size) throw (std::bad_alloc)
 
void operator delete (void *p)
 

Detailed Description

Film. A base class of the films. The class is used to rendered images equipped with cameras.

Inheritance diagram for Film:
Asset Component SIMDAlignedType BitmapFilm StubFilm HDRBitmapFilm LDRBitmapFilm

Member Function Documentation

virtual void Film::AccumulateContribution ( const Math::Vec2 &  rasterPos,
const Math::Vec3 &  contrb 
)
pure virtual

Accumulate the contribution to the raster position. This function accumulates #contrb to the position specified by #rasterPos.

Parameters
rasterPosRaster position.
contrbContribution.

Implemented in HDRBitmapFilm, LDRBitmapFilm, and StubFilm.

virtual void Film::AccumulateContribution ( const Film film)
pure virtual

Accumulate the contribution to the entire film. This function accumulates the contribution of the other film. The other film must be same size and type.

Parameters
filmOther film.

Implemented in HDRBitmapFilm, LDRBitmapFilm, and StubFilm.

virtual Film* Film::Clone ( ) const
pure virtual

Clone the film.

Returns
Duplicated film.

Implemented in HDRBitmapFilm, LDRBitmapFilm, and StubFilm.

virtual int Film::Height ( ) const
pure virtual

Get the height of the film.

Returns
Height of the film.

Implemented in HDRBitmapFilm, LDRBitmapFilm, and StubFilm.

virtual void Film::RecordContribution ( const Math::Vec2 &  rasterPos,
const Math::Vec3 &  contrb 
)
pure virtual

Record the contribution to the raster position. This function records #contrb to the position specified by #rasterPos.

Parameters
rasterPosRaster position.
contrbContribution.

Implemented in HDRBitmapFilm, LDRBitmapFilm, and StubFilm.

virtual void Film::Rescale ( const Math::Float &  weight)
pure virtual

Rescale the pixel values by constant weight.

Parameters
weightRescaling weight.

Implemented in HDRBitmapFilm, LDRBitmapFilm, and StubFilm.

virtual int Film::Width ( ) const
pure virtual

Get the width of the film.

Returns
Width of the film.

Implemented in HDRBitmapFilm, LDRBitmapFilm, and StubFilm.


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