ViewpointStatistics

Detailed Description

class ViewpointStatistics : public RED::Object

Frame statistics for a single viewpoint.

The rendering in REDsdk happens for each VRL and for each camera in each VRL (see \ref bk_ba_viewpoint_render_lists for details). This class contains informations resulting of the rendering of a single viewpoint in a VRL. An instance of this class is accessible for each processed viewpoint of each VRL from the RED::FrameStatistics container class. Instanced viewpoints each have their own statistics object returned.

Public Functions

SET_CID (CID_class_REDViewpointStatistics) IMPLEMENT_AS()
ViewpointStatistics()

ViewpointStatistics default construction method.

~ViewpointStatistics()

ViewpointStatistics destruction method.

ViewpointStatistics(const RED::ViewpointStatistics &iSrc)

ViewpointStatistics copy construction operator.

Parameters:iSrc – Source of the copy.
RED_RC operator=(const RED::ViewpointStatistics &iSrc)

Assignment operator.

Parameters:iSrc – Source of the operation.
Returns:RED_OK if the operation has succeeded,

RED_ALLOC_FAILURE if an internal allocation has failed.
inline RED::Object *GetWindow() const

Gets the rendered window.

Returns:The window address for which this viewpoint is being rendered.
inline RED::Object *GetVRL() const

Gets the rendered viewpoint render list.

Returns:The address of the VRL for which this viewpoint is being rendered.
inline RED::Object *GetViewpoint() const

Gets the rendered viewpoint.

This method returns the viewpoint object being rendered and for which this statistics object is being created.

Returns:The viewpoint address.
inline unsigned int GetImageWidth() const

Access to dimensions of the calculated image.

Dimensions returned are those of the viewport area covered by this viewpoint.

Returns:The calculated image width in pixels for this viewpoint.
inline unsigned int GetImageHeight() const

Access to dimensions of the calculated image.

Dimensions returned are those of the viewport area covered by this viewpoint.

Returns:The calculated image height in pixels for this viewpoint.
inline RED::RENDERING_PROGRESS_STEP GetSoftwareRenderStep() const
Returns:The current software rendering step.
inline int GetSoftwareRenderStepPass() const
Returns:The number of the current rendering pass in the rendering step.
inline int GetSoftwareRenderStepPassesCount() const
Returns:The total number of rendering passes to proceed for the current rendering step.
inline float GetSoftwarePassProgress() const

Returns a value that indicates the percentage of the image that has been processed.

This may be slightly inaccurate when the adaptive anti-aliasing is enabled, because we can’t predict the amount of calculation that will be really needed due to the adaptivity.

Returns:The percentage of completion of the current pass in the current rendering step. The returned value is in [0.0,1.0].
inline unsigned int GetSoftwareRaysCount() const
Returns:The number of rays that have been calculated for the frame.
inline unsigned int GetSoftwareGICacheSamplesCount() const

Returns the number of irradiance samples.

This counter is set after the termination of all global illumination passes, when the irradiance cache has been calculated. It contains the total number of irradiance samples we have at our disposal for the restitution of the global illumination solution.

Returns:The number of irradiance samples in the cache.
inline unsigned int GetCausticPhotonsCount() const

Returns the number of caustic photons.

This counter is set after the termination of the caustic photons pass. It contains the total number caustic photons which are stored in the caustic photons map and will be used to estimate reflective and refractive caustics during rendering.

Returns:The number of irradiance samples in the cache.
inline float GetSoftwareElapsedTime() const

Gets the total elapsed time since the frame startup.

Returns:The total elapsed time in milliseconds.
inline float GetSoftwareRemainingTime() const

Gets the estimated remaining time in the current pass.

Note that we can’t estimate the remaining time on a pass that has not been started yet. The sum of the elapsed time plus the remaining time gives the total frame time if we have reached the last pass for the current image setup. The time is defined for the current pass in the current rendering step.

Returns:The remaining time in milliseconds for the current pass.
inline int GetPassesCount() const

Return the number of rendering passes.

Returns:The number of passes.
inline const RED::PassStatistics &GetPassStatistics(int iNumPass) const

Return the parameters for a rendering pass.

Returns:The data record of a single rendering pass.