Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::MainLoopProfilingSampler Class Reference

MainLoopProfilingSampler implements profiling sampler for MainLoopProfiler. More...

#include <kanzi/core.ui/main_loop/main_loop_profiler.hpp>

Inheritance diagram for kanzi::MainLoopProfilingSampler:
[legend]

Public Member Functions

MainLoopProfilingSampleData getSampleData () const
 Creates an instance of MainLoopProfilingSampleData filled with data provided to the sampler. More...
 
 MainLoopProfilingSampler (MainLoopProfilingScopeToken token, uint64_t frameNumber)
 Constructor. More...
 
- Public Member Functions inherited from kanzi::IntervalProfilingSampler
IntervalProfilerSampleData getSampleData ()
 Returns IntervalProfilerSampleData sample including interval measurement data. More...
 
void start ()
 Starts measuring time interval duration. More...
 
void stop ()
 Finishes measuring time interval duration. More...
 

Additional Inherited Members

- Protected Attributes inherited from kanzi::IntervalProfilingSampler
TimePoint m_endTimePoint
 The point in time when interval measurement finished. More...
 
TimePoint m_startTimePoint
 The point in time when interval measurement started. More...
 

Detailed Description

MainLoopProfilingSampler implements profiling sampler for MainLoopProfiler.

Constructor & Destructor Documentation

kanzi::MainLoopProfilingSampler::MainLoopProfilingSampler ( MainLoopProfilingScopeToken  token,
uint64_t  frameNumber 
)
inlineexplicit

Constructor.

Parameters
tokenToken of the profiled scope. See MainLoopProfiler::registerScope.
frameNumberFrame number of the sample in the main loop.

Member Function Documentation

MainLoopProfilingSampleData kanzi::MainLoopProfilingSampler::getSampleData ( ) const

Creates an instance of MainLoopProfilingSampleData filled with data provided to the sampler.

Returns
Instance of MainLoopProfilingSampleData.

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