RenderMan API  23.0
RixTimer Class Referenceabstract

#include <RixInterfaces.h>

Inheritance diagram for RixTimer:
RixInterface

Public Member Functions

virtual uint64_t SampleTime ()=0
 Return a high resolution time sample. More...
 
virtual float ConvertIntervalToSeconds (uint64_t interval)=0
 Convert a high res time interval to seconds of time. More...
 
- Public Member Functions inherited from RixInterface
virtual int GetVersion () const
 

Protected Member Functions

 RixTimer ()
 
- Protected Member Functions inherited from RixInterface
 RixInterface (int version)
 Interfaces should not be constructed by users. More...
 
virtual ~RixInterface ()
 Interfaces should not be deleted by users. More...
 

Additional Inherited Members

- Public Types inherited from RixInterface
enum  Type {
  k_Float, k_Integer, k_StringV, k_Color,
  k_Normal, k_Vector, k_Point, k_HPoint,
  k_MPoint, k_Matrix
}
 
- Protected Attributes inherited from RixInterface
int m_version
 Version number of this interface. More...
 

Detailed Description

NOTE: This interface will be deprecated when a new interface comes in the next release Interface for sampling a high-resolution representation of the current time. Primarily useful for statistics gathering of timing information for plugins that operate within the renderer. In a multicore environment time sampling is a little challenging and can incur overhead. To support multithreaded operation ( i.e.for RixShadingPlugins, procprims, rifs), the standard idiom is to measure the time differential across a single code execution block. The value should be stored in a per-thread (lockless) context then summed across threads when a total is required. Note, these totals can exceed "user time".

Definition at line 1142 of file RixInterfaces.h.

Constructor & Destructor Documentation

◆ RixTimer()

RixTimer::RixTimer ( )
inlineprotected

Definition at line 1151 of file RixInterfaces.h.

Member Function Documentation

◆ ConvertIntervalToSeconds()

virtual float RixTimer::ConvertIntervalToSeconds ( uint64_t  interval)
pure virtual

Convert a high res time interval to seconds of time.

◆ SampleTime()

virtual uint64_t RixTimer::SampleTime ( )
pure virtual

Return a high resolution time sample.


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