#include <ecfilm.h>
Public Types | |
enum | eFilmFilterType |
Defines supported Antialias filter types for film. | |
Public Member Functions | |
Film (const char *a_sID, int a_nWidth, int a_nHeight, eFilmFilterType a_nFilterType, float a_fFilterSize, float a_fGamma, bool a_bHasDepth, bool a_bClamp) | |
Construction. | |
YRFilm * | GetYRFilm () |
Provides access to our film object. | |
int | GetWidth () const |
Get the film width. | |
int | GetHeight () const |
Get the film height. | |
virtual PYOBJECT | PyAsString () |
Python text representation method This function must be implemented by all children. | |
Static Public Member Functions | |
static bool | PyTypeCheck (PYOBJECT a_pObject) |
Python type check Verifies that the provided python object encapsulates a film object. | |
static void | AppendFilmFilterTypes (PYOBJECT a_pPyModule) |
Appends film filter type identifiers to the module of the provided dictionary. | |
Protected Member Functions | |
virtual void | DeleteObject () |
Child message hook for reference-count based destruction. |
Defines a film object that keeps rendering settings and output data.
This is particularly handy if we render multiple versions of the same scene, or attach different maps to the same mesh.
Output formats are EXR or simple TGA. Since the second one is more useful this is the one we implement. In the future, however, should be easy to add support for the other, if necessary.
Definition at line 47 of file ecfilm.h.
Film::Film | ( | const char * | a_sID, | |
int | a_nWidth, | |||
int | a_nHeight, | |||
eFilmFilterType | a_nFilterType, | |||
float | a_fFilterSize, | |||
float | a_fGamma, | |||
bool | a_bHasDepth, | |||
bool | a_bClamp | |||
) |
Construction.
a_sOutputName | Name of the image file to contain the film output, with extension. | |
a_nWidth | Film width | |
a_nHeight | Film height | |
a_nFilterType | Antialias filter type | |
a_fFilterSize | Pixel width | |
a_fGamma | Film gamma correction | |
a_bHasDepth | If true, add depth channel to the film | |
a_bClampRGB | If true, clamp rgb values to 0-1 |
static void Film::AppendFilmFilterTypes | ( | PYOBJECT | a_pPyModule | ) | [static] |
Appends film filter type identifiers to the module of the provided dictionary.
a_pPyModule | A valid python module |
virtual void Film::DeleteObject | ( | ) | [protected, virtual] |
Child message hook for reference-count based destruction.
The child class is responsible for deleting any instance to which this this function is called.
Reimplemented from EclipseObject.
int Film::GetHeight | ( | ) | const [inline] |
int Film::GetWidth | ( | ) | const [inline] |
YRFilm* Film::GetYRFilm | ( | ) | [inline] |
virtual PYOBJECT Film::PyAsString | ( | ) | [virtual] |
Python text representation method This function must be implemented by all children.
Reimplemented from EclipseObject.
static bool Film::PyTypeCheck | ( | PYOBJECT | a_pObject | ) | [static] |
Python type check Verifies that the provided python object encapsulates a film object.
Reimplemented from EclipseObject.