Kanzi 3.9.10
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.
 
 MainLoopProfilingSampler (MainLoopProfilingScopeToken token, uint64_t frameNumber)
 Constructor.
 
- Public Member Functions inherited from kanzi::IntervalProfilingSampler
IntervalProfilerSampleData getSampleData ()
 Returns IntervalProfilerSampleData sample including interval measurement data.
 
void start ()
 Starts measuring time interval duration.
 
void stop ()
 Finishes measuring time interval duration.
 

Additional Inherited Members

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

Detailed Description

MainLoopProfilingSampler implements profiling sampler for MainLoopProfiler.

Constructor & Destructor Documentation

◆ MainLoopProfilingSampler()

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

◆ getSampleData()

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: