FBProfileTimeEvent Class Reference

FBProfileTimeEvent. More...

#include <pyfbsdk.h>

Inheritance diagram for FBProfileTimeEvent:

Public Member Functions
list	GetColor ()
	Get the color assigned to the event.
str	GetComment ()
	Get the comment for the event.
int	GetThreadID ()
	Get the thread ID used in the event execution.
FBTime	GetTime ()
	Get the time when the event occurred.
str	GetTypeName ()
	Get the event registered type name.
bool	IsSingleEvent ()
	Three types of events exits: single, start and end.

Detailed Description

FBProfileTimeEvent.

Time event information is collected during sampling (activated with a property in FBProfiler ActiveSampling). Events that can be collected are: render, evaluation, model evaluation, model deformation, synchronization of evaluation and rendering, playback commands, etc.Sampling will stop when the buffers maximum size is reached (maximum is 10MB).Currently users are not able to register any new events from ORSDK/python

Member Function Documentation

GetColor()

list GetColor

(

)

Get the color assigned to the event.

GetComment()

str GetComment

(

)

Get the comment for the event.

Comments are not editable.

GetThreadID()

int GetThreadID

(

)

Get the thread ID used in the event execution.

GetTime()

FBTime GetTime

(

)

Get the time when the event occurred.

GetTypeName()

str GetTypeName

(

)

Get the event registered type name.

IsSingleEvent()

bool IsSingleEvent

(

)

Three types of events exits: single, start and end.

Some actions that takes more time to execute or when other events can occur inbetween are collected with start time event at begin and end time event at finish.