Abstract film base class - used to store samples generated by Integrator implementations. More...
#include <mitsuba/render/film.h>
Public Member Functions | |
const Vector2i & | getSize () const |
Ignoring the crop window, return the resolution of the underlying sensor. More... | |
const Vector2i & | getCropSize () const |
Return the size of the crop window. More... | |
const Point2i & | getCropOffset () const |
Return the offset of the crop window. More... | |
virtual void | clear ()=0 |
Clear the film. More... | |
virtual void | put (const ImageBlock *block)=0 |
Merge an image block into the film. More... | |
virtual void | setBitmap (const Bitmap *bitmap, Float multiplier=1.0f)=0 |
Overwrite the film with the given bitmap and optionally multiply it by a scalar. More... | |
virtual void | addBitmap (const Bitmap *bitmap, Float multiplier=1.0f)=0 |
Accumulate a bitmap on top of the radiance values stored in the film. More... | |
virtual void | setDestinationFile (const fs::path &filename, uint32_t blockSize)=0 |
Set the target filename (with or without extension) More... | |
virtual void | develop (const Scene *scene, Float renderTime)=0 |
Develop the film and write the result to the previously specified filename. More... | |
virtual bool | develop (const Point2i &offset, const Vector2i &size, const Point2i &targetOffset, Bitmap *target) const =0 |
Develop the contents of a subregion of the film and store it inside the given bitmap. More... | |
virtual bool | destinationExists (const fs::path &basename) const =0 |
Does the destination file already exist? More... | |
bool | hasHighQualityEdges () const |
virtual bool | hasAlpha () const =0 |
Return whether or not this film records the alpha channel. More... | |
ReconstructionFilter * | getReconstructionFilter () |
Return the image reconstruction filter. More... | |
const ReconstructionFilter * | getReconstructionFilter () const |
Return the image reconstruction filter (const version) More... | |
virtual const Class * | getClass () const |
Retrieve this object's class. More... | |
ConfigurableObject interface | |
virtual void | addChild (const std::string &name, ConfigurableObject *child) |
Add a child node. More... | |
void | addChild (ConfigurableObject *child) |
Add an unnamed child. More... | |
virtual void | configure () |
Configure the film. More... | |
virtual void | serialize (Stream *stream, InstanceManager *manager) const |
Serialize this film to a binary data stream. More... | |
![]() | |
virtual void | setParent (ConfigurableObject *parent) |
Notify the ConfigurableObject instance about its parent object. More... | |
void | addChild (ConfigurableObject *child) |
Add an unnamed child. More... | |
const std::string & | getID () const |
Return the identifier associated with this instance (or "unnamed") More... | |
void | setID (const std::string &name) |
Set the identifier associated with this instance. More... | |
const Properties & | getProperties () const |
Return the properties object that was originally used to create this instance. More... | |
![]() | |
SerializableObject (Stream *stream, InstanceManager *manager) | |
Unserialize a serializable object. More... | |
![]() | |
Object () | |
Construct a new object. More... | |
int | getRefCount () const |
Return the current reference count. More... | |
void | incRef () const |
Increase the reference count of the object by one. More... | |
void | decRef (bool autoDeallocate=true) const |
Decrease the reference count of the object and possibly deallocate it. More... | |
virtual std::string | toString () const |
Return a human-readable string representation of the object's contents. More... | |
Static Public Attributes | |
static Class * | m_theClass |
![]() | |
static Class * | m_theClass |
![]() | |
static Class * | m_theClass |
![]() | |
static Class * | m_theClass |
Pointer to the object's class descriptor. More... | |
Protected Member Functions | |
Film (const Properties &props) | |
Create a film. More... | |
Film (Stream *stream, InstanceManager *manager) | |
Unserialize a film. More... | |
virtual | ~Film () |
Virtual destructor. More... | |
![]() | |
virtual | ~ConfigurableObject () |
Virtual destructor. More... | |
ConfigurableObject (const Properties &props) | |
Construct a configurable object. More... | |
ConfigurableObject (Stream *stream, InstanceManager *manager) | |
Unserialize a configurable object. More... | |
![]() | |
SerializableObject () | |
Construct a serializable object. More... | |
virtual | ~SerializableObject () |
Virtual deconstructor. More... | |
![]() | |
virtual | ~Object () |
Virtual private deconstructor. (Will only be called by ref) More... | |
Protected Attributes | |
Point2i | m_cropOffset |
Vector2i | m_size |
Vector2i | m_cropSize |
bool | m_highQualityEdges |
ref< ReconstructionFilter > | m_filter |
![]() | |
Properties | m_properties |
Additional Inherited Members | |
![]() | |
static void | staticInitialization () |
Initializes the built-in reference count debugger (if enabled) More... | |
static void | staticShutdown () |
Free the memory taken by staticInitialization() More... | |
Abstract film base class - used to store samples generated by Integrator implementations.
To avoid lock-related bottlenecks when rendering with many cores, rendering threads first store results in an "image block", which is then committed to the film.
|
protected |
Create a film.
|
protected |
Unserialize a film.
|
protectedvirtual |
Virtual destructor.
|
pure virtual |
Accumulate a bitmap on top of the radiance values stored in the film.
|
virtual |
Add a child node.
Reimplemented from mitsuba::ConfigurableObject.
|
inline |
Add an unnamed child.
|
pure virtual |
Clear the film.
|
virtual |
Configure the film.
Reimplemented from mitsuba::ConfigurableObject.
|
pure virtual |
Does the destination file already exist?
Develop the film and write the result to the previously specified filename.
|
pure virtual |
Develop the contents of a subregion of the film and store it inside the given bitmap.
This may fail when the film does not have an explicit representation of the bitmap in question (e.g. when it is writing to a tiled EXR image)
true
upon success
|
virtual |
Retrieve this object's class.
Reimplemented from mitsuba::ConfigurableObject.
|
inline |
Return the offset of the crop window.
|
inline |
Return the size of the crop window.
|
inline |
Return the image reconstruction filter.
|
inline |
Return the image reconstruction filter (const version)
|
inline |
Ignoring the crop window, return the resolution of the underlying sensor.
|
pure virtual |
Return whether or not this film records the alpha channel.
|
inline |
Should regions slightly outside the image plane be sampled to improve the quality of the reconstruction at the edges? This only makes sense when reconstruction filters other than the box filter are used.
|
pure virtual |
Merge an image block into the film.
|
virtual |
Serialize this film to a binary data stream.
Reimplemented from mitsuba::ConfigurableObject.
|
pure virtual |
Overwrite the film with the given bitmap and optionally multiply it by a scalar.
|
pure virtual |
Set the target filename (with or without extension)
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
static |