#include <bitmapfilm.h>

Public Member Functions
virtual bool	Save (const std::string &path) const =0

virtual bool	RescaleAndSave (const std::string &path, const Math::Float &weight) const =0

virtual void	Allocate (int width, int height)=0

virtual void	SetImageType (BitmapImageType type)=0

virtual BitmapImageType	ImageType () const =0

virtual BitmapImage &	Bitmap ()=0

Public Member Functions inherited from Film
	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 Film *	Clone () 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

Bitmap film. An interface for films contained in a bitmap image.

Inheritance diagram for BitmapFilm:

Member Function Documentation

virtual void BitmapFilm::Allocate	(	int	width,
		int	height
	)

pure virtual

Allocate the film with given width and height.

Parameters

width	Width of the film.
height	Height of the film.

virtual BitmapImage& BitmapFilm::Bitmap ( )

pure virtual

Get internal bitmap data.

virtual BitmapImageType BitmapFilm::ImageType ( ) const

pure virtual

Get bitmap image type.

virtual bool BitmapFilm::RescaleAndSave	(	const std::string &	path,
		const Math::Float &	weight
	)		const

pure virtual

Rescale and save as image. Save the film as image after rescaling values for each pixel.

Parameters

path	Path to the output image.
weight	Rescaling weight.

Return values

true	Succeeded to save the image.
false	Failed to save the image.

virtual bool BitmapFilm::Save ( const std::string & path ) const

pure virtual

Save as image. Saves the film as image. If #path is empty, the default path is used.

Parameters

path	Path to the output image.

Return values

true	Succeeded to save the image.
false	Failed to save the image.

virtual void BitmapFilm::SetImageType ( BitmapImageType type )

pure virtual

Set bitmap image type.

Parameters

type	Bitmap image type.

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