Film Class Reference

Film. More...

#include <film.h>

Inheritance diagram for Film:

Public Member Functions
	LM_INTERFACE_CLASS (Film, Asset, 8)
	LM_DISABLE_COPY_AND_MOVE (Film)
	LM_INTERFACE_F (0, Width, int())
	Width of the film. More...
	LM_INTERFACE_F (1, Height, int())
	Height of the film. More...
	LM_INTERFACE_F (2, Splat, void(const Vec2 &rasterPos, const SPD &v))
	Accumulate the contribution to the raster position. This function accumulates (splats) the contribution v to the raster position rasterPos. More...
	LM_INTERFACE_F (3, SetPixel, void(int x, int y, const SPD &v))
	Set the value of the pixel. This function set the pixel value specified by v to the screen coordinates (x,y). More...
	LM_INTERFACE_F (4, Save, bool(const std::string &))
	Save as image. Saves the film as image. If path is empty, the default path is used. More...
	LM_INTERFACE_F (5, Accumulate, void(const Film *film))
	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. More...
	LM_INTERFACE_F (6, Rescale, void(Float w))
	Rescale the pixel values by the constant weight. More...
	LM_INTERFACE_F (7, Clear, void())
	Clear the film. Fills in the pixel values to zero.
Public Member Functions inherited from Asset
	LM_INTERFACE_CLASS (Asset, Clonable, 2)
	LM_DISABLE_COPY_AND_MOVE (Asset)
	LM_INTERFACE_F (0, Load, bool(const PropertyNode *prop, Assets *assets, const Primitive *primitive))
	Load an asset from a property node. More...
	LM_INTERFACE_F (1, PostLoad, bool(const Scene *scene))
	Post processing of the asset. More...
Public Member Functions inherited from Clonable
	LM_INTERFACE_CLASS (Clonable, Component, 1)
	LM_DISABLE_COPY_AND_MOVE (Clonable)
	LM_INTERFACE_F (0, Clone, void(Clonable *o))
	Clone the instalce. More...
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 sensor.

Member Function Documentation

Film::LM_INTERFACE_F	(	0	,
		Width	,
		int()
	)

Width of the film.

Returns

Width of the film.

Film::LM_INTERFACE_F	(	1	,
		Height	,
		int()
	)

Height of the film.

Returns

Height of the film.

Film::LM_INTERFACE_F	(	2	,
		Splat	,
		void(const Vec2 &rasterPos, const SPD &v)
	)

Accumulate the contribution to the raster position. This function accumulates (splats) the contribution v to the raster position rasterPos.

Parameters

rasterPos	Raster position.
contrb	Contribution.

Film::LM_INTERFACE_F	(	3	,
		SetPixel	,
		void(int x, int y, const SPD &v)
	)

Set the value of the pixel. This function set the pixel value specified by v to the screen coordinates (x,y).

Parameters

rasterPos	Raster position.
contrb	Contribution.

Film::LM_INTERFACE_F	(	4	,
		Save	,
		bool(const std::string &)
	)

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.

Film::LM_INTERFACE_F	(	5	,
		Accumulate	,
		void(const Film *film)
	)

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

film	Other film.

Film::LM_INTERFACE_F	(	6	,
		Rescale	,
		void(Float w)
	)

Rescale the pixel values by the constant weight.

Parameters

w	Rescaling weight.