nv::index::IFrame_results Class Reference

The frame results store information gathered during the rendering process. More...

#include <iindex.h>

Inherits mi::base::Interface_declare< 0xdbe8f991, ... >.

Public Member Functions
virtual IPerformance_values *	get_performance_values () const =0
	Returns an instance of the performance values interface IPerformance_values containing detailed performance information gathered during the rendering process. More...
virtual IError_set *	get_error_set () const =0
	Returns an instance of the error set interface IError_set containing information about the success or failure of the rendering process. More...
virtual IFrame_identifier	get_frame_id () const =0
	The frame id uniquely identifies the rendered frame. More...

Detailed Description

The frame results store information gathered during the rendering process.

Such information include error information and the performance values.

Member Function Documentation

get_error_set()

virtual IError_set * nv::index::IFrame_results::get_error_set ( ) const

pure virtual

Returns an instance of the error set interface IError_set containing information about the success or failure of the rendering process.

Note

Use the mi::base::Handle template to store the returned interface pointer in order to guarantee the correct destruction of the returned interface.

Returns

Returns an error set containing information about the success or failure of the rendering process.

get_frame_id()

virtual IFrame_identifier nv::index::IFrame_results::get_frame_id ( ) const

pure virtual

The frame id uniquely identifies the rendered frame.

The if of the rendered frame can be identified uniquely. This allows to assign frame rendering results in a distinct way, e.g., to certain performance values.

Returns

Returns a unique frame id.

get_performance_values()

virtual IPerformance_values * nv::index::IFrame_results::get_performance_values ( ) const

pure virtual

Returns an instance of the performance values interface IPerformance_values containing detailed performance information gathered during the rendering process.

Note

Use the mi::base::Handle template to store the returned interface pointer in order to guarantee the correct destruction of the returned interface.

Returns

The the detailed performance values information gathered during the rendering process.

---

The documentation for this class was generated from the following file:

• iindex.h