class RED::ViewpointStatistics

Frame statistics for a single viewpoint. More...

#include <REDFrameStatistics.h>

Inherits: Object.

Public functions:

	ViewpointStatistics ( )
	ViewpointStatistics ( const RED::ViewpointStatistics & iSrc )
	~ViewpointStatistics ( )
virtual void *	As ( const RED::CID & iCID )
virtual const void *	As ( const RED::CID & iCID ) const
template< class T_As > const T_As *	As ( ) const
template< class T_As > T_As *	As ( )
unsigned int	GetCausticPhotonsCount ( ) const
unsigned int	GetImageHeight ( ) const
unsigned int	GetImageWidth ( ) const
int	GetPassesCount ( ) const
const RED::PassStatistics &	GetPassStatistics ( int iNumPass ) const
float	GetSoftwareElapsedTime ( ) const
unsigned int	GetSoftwareGICacheSamplesCount ( ) const
float	GetSoftwarePassProgress ( ) const
unsigned int	GetSoftwareRaysCount ( ) const
float	GetSoftwareRemainingTime ( ) const
RED::RENDERING_PROGRESS_STEP	GetSoftwareRenderStep ( ) const
int	GetSoftwareRenderStepPass ( ) const
int	GetSoftwareRenderStepPassesCount ( ) const
RED::Object *	GetViewpoint ( ) const
RED::Object *	GetVRL ( ) const
RED::Object *	GetWindow ( ) const
RED_RC	operator= ( const RED::ViewpointStatistics & iSrc )

Detailed description:

Frame statistics for a single viewpoint.

The rendering in REDsdk happens for each VRL and for each camera in each VRL (see 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.

Functions documentation

public RED::ViewpointStatistics::ViewpointStatistics

(

)

ViewpointStatistics default construction method.

public RED::ViewpointStatistics::ViewpointStatistics

(

const RED::ViewpointStatistics &

iSrc

)

ViewpointStatistics copy construction operator.

Parameters:

iSrc:

Source of the copy.

public RED::ViewpointStatistics::~ViewpointStatistics

(

)

ViewpointStatistics destruction method.

public static RED::CID RED::ViewpointStatistics::GetClassID

(

)

Reimplements: RED::Object::GetClassID.

public virtual void * RED::ViewpointStatistics::As

(

const RED::CID &

iCID

)

Converts the object to an instance of the given type.

Parameters:

iCID:

Requested class.

Returns:

An object pointer of the given class on success, NULL otherwise.

Reimplements: RED::Object::As.

public virtual const void * RED::ViewpointStatistics::As

(

const RED::CID &

iCID

) const

Converts the object to an instance of the given type.

Parameters:

iCID:

Requested class.

Returns:

An object pointer of the given class on success, NULL otherwise.

Reimplements: RED::Object::As.

template< class T_As > public const T_As * RED::ViewpointStatistics::As

(

) const

Template version of the as const method.

Simply set T to be the class you want to retrieve an interface to.

Returns:

A pointer to a const instance of class T on success, NULL otherwise.

Reimplements: RED::Object::As.

template< class T_As > public T_As * RED::ViewpointStatistics::As

(

)

Template version of the as method.

Simply set T to be the class you want to retrieve an interface to.

Returns:

A pointer to an instance of class T on success, NULL otherwise.

Reimplements: RED::Object::As.

public unsigned int RED::ViewpointStatistics::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.

public unsigned int RED::ViewpointStatistics::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.

public unsigned int RED::ViewpointStatistics::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.

public int RED::ViewpointStatistics::GetPassesCount

(

) const

Return the number of rendering passes.

Returns:

The number of passes.

public const RED::PassStatistics & RED::ViewpointStatistics::GetPassStatistics

(

int

iNumPass

) const

Return the parameters for a rendering pass.

Returns:

The data record of a single rendering pass.

public float RED::ViewpointStatistics::GetSoftwareElapsedTime

(

) const

Gets the total elapsed time since the frame startup.

Returns:

The total elapsed time in milliseconds.

public unsigned int RED::ViewpointStatistics::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.

public float RED::ViewpointStatistics::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].

public unsigned int RED::ViewpointStatistics::GetSoftwareRaysCount

(

) const

Returns:

The number of rays that have been calculated for the frame.

public float RED::ViewpointStatistics::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.

public RED::RENDERING_PROGRESS_STEP RED::ViewpointStatistics::GetSoftwareRenderStep

(

) const

Returns:

The current software rendering step.

public int RED::ViewpointStatistics::GetSoftwareRenderStepPass

(

) const

Returns:

The number of the current rendering pass in the rendering step.