Dali 3D User Interface Engine
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Private Attributes
Dali::Internal::Adaptor::PerformanceMarker Class Reference

Marker used to record an event with a time stamp in Dali. More...

#include <performance-marker.h>

Collaboration diagram for Dali::Internal::Adaptor::PerformanceMarker:
Collaboration graph
[legend]

Public Types

enum  MarkerFilter {
  FILTERING_DISABLED = 0, V_SYNC_EVENTS = 1 << 0, UPDATE = 1 << 1, RENDER = 1 << 2,
  EVENT_PROCESS = 1 << 3, SWAP_BUFFERS = 1 << 4, LIFE_CYCLE_EVENTS = 1 << 5, RESOURCE_EVENTS = 1 << 6,
  CUSTOM_EVENTS = 1 << 7
}
 Bitmask used to filter different types of markers based on what group they belong to. More...
 
enum  MarkerEventType { SINGLE_EVENT, START_TIMED_EVENT, END_TIMED_EVENT }
 Marker event type. More...
 

Public Member Functions

 PerformanceMarker (PerformanceInterface::MarkerType type)
 Constructor. More...
 
 PerformanceMarker (PerformanceInterface::MarkerType type, FrameTimeStamp time)
 Constructor. More...
 
const FrameTimeStampGetTimeStamp () const
 
PerformanceInterface::MarkerType GetType () const
 
MarkerEventType GetEventType () const
 
MarkerFilter GetFilterType () const
 
const char *const GetName () const
 
bool IsFilterEnabled (MarkerFilter filter) const
 

Static Public Member Functions

static unsigned int MicrosecondDiff (const PerformanceMarker &start, const PerformanceMarker &end)
 

Private Attributes

PerformanceInterface::MarkerType mType
 marker type More...
 
FrameTimeStamp mTimeStamp
 frame time stamp More...
 

Detailed Description

Marker used to record an event with a time stamp in Dali.

Definition at line 37 of file performance-marker.h.

Member Enumeration Documentation

Marker event type.

Enumerator
SINGLE_EVENT 

event is something that has no duration associated with it

START_TIMED_EVENT 

start of a timed event

END_TIMED_EVENT 

end of a timed event

Definition at line 62 of file performance-marker.h.

Bitmask used to filter different types of markers based on what group they belong to.

Enumerator
FILTERING_DISABLED 

disabled

V_SYNC_EVENTS 

v-sync

UPDATE 

update start / end

RENDER 

render start / end

EVENT_PROCESS 

process events start / end

SWAP_BUFFERS 

swap buffers start / end

LIFE_CYCLE_EVENTS 

pause / resume

RESOURCE_EVENTS 

resource events

CUSTOM_EVENTS 

Definition at line 46 of file performance-marker.h.

Constructor & Destructor Documentation

Dali::Internal::Adaptor::PerformanceMarker::PerformanceMarker ( PerformanceInterface::MarkerType  type)

Constructor.

Parameters
[in]typemarker type

Definition at line 69 of file performance-marker.cpp.

Dali::Internal::Adaptor::PerformanceMarker::PerformanceMarker ( PerformanceInterface::MarkerType  type,
FrameTimeStamp  time 
)

Constructor.

Parameters
[in]typemarker type
[in]timetime stamp

Definition at line 74 of file performance-marker.cpp.

Member Function Documentation

PerformanceMarker::MarkerEventType Dali::Internal::Adaptor::PerformanceMarker::GetEventType ( ) const
PerformanceMarker::MarkerFilter Dali::Internal::Adaptor::PerformanceMarker::GetFilterType ( ) const
const char *const Dali::Internal::Adaptor::PerformanceMarker::GetName ( ) const
const FrameTimeStamp& Dali::Internal::Adaptor::PerformanceMarker::GetTimeStamp ( ) const
inline
PerformanceInterface::MarkerType Dali::Internal::Adaptor::PerformanceMarker::GetType ( ) const
inline
Returns
the type of marker

Definition at line 95 of file performance-marker.h.

References mType.

Referenced by Dali::Internal::Adaptor::StatContext::ProcessInternalMarker().

Here is the caller graph for this function:

bool Dali::Internal::Adaptor::PerformanceMarker::IsFilterEnabled ( MarkerFilter  filter) const
Returns
if a marker is enabled as part of a group

Definition at line 100 of file performance-marker.cpp.

References Dali::Internal::Adaptor::anonymous_namespace{performance-marker.cpp}::MARKER_LOOKUP, and mType.

Referenced by Dali::Internal::Adaptor::StatContext::ProcessInternalMarker(), and Dali::Internal::Adaptor::NetworkPerformanceClient::TransmitMarker().

Here is the caller graph for this function:

unsigned int Dali::Internal::Adaptor::PerformanceMarker::MicrosecondDiff ( const PerformanceMarker start,
const PerformanceMarker end 
)
static
Parameters
startthe start marker
endthe end marker
Returns
difference in microseconds between two markers

Definition at line 95 of file performance-marker.cpp.

References Dali::Internal::Adaptor::FrameTimeStamp::MicrosecondDiff(), and mTimeStamp.

Referenced by Dali::Internal::Adaptor::StatContext::FrameTick().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

FrameTimeStamp Dali::Internal::Adaptor::PerformanceMarker::mTimeStamp
private

frame time stamp

Definition at line 130 of file performance-marker.h.

Referenced by GetTimeStamp(), and MicrosecondDiff().

PerformanceInterface::MarkerType Dali::Internal::Adaptor::PerformanceMarker::mType
private

marker type

Definition at line 129 of file performance-marker.h.

Referenced by GetEventType(), GetFilterType(), GetName(), GetType(), and IsFilterEnabled().


The documentation for this class was generated from the following files:
Dali Docs Home
Read more about Dali