FBProfileTimeEvent Class Reference
#include <mobu-python-api.h>
Class Description
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
Inheritance diagram for FBProfileTimeEvent:
Public Member Functions | |
| __reduce__ () | |
| FBTime | GetTime (FBProfileTimeEvent arg1) |
| Get the time when the event occurred. More... | |
| FBColor | GetColor (FBProfileTimeEvent arg1) |
| Get the color assigned to the event. More... | |
| str | GetTypeName (FBProfileTimeEvent arg1) |
| Get the event registered type name. More... | |
| str | GetComment (FBProfileTimeEvent arg1) |
| Get the comment for the event. More... | |
| int | GetThreadID (FBProfileTimeEvent arg1) |
| Get the thread ID used in the event execution. More... | |
| bool | IsSingleEvent (FBProfileTimeEvent arg1) |
| Three types of events exits: single, start and end. More... | |
| __init__ (...) | |
Member Function Documentation
| __init__ | ( | ... | ) |
Python Docstring:
Raises an exception This class cannot be instantiated from Python
C++ Constructors:
The reference documentation for the following C++ symbols may contain additional relevant information.
| __reduce__ | ( | ) |
| FBColor GetColor | ( | FBProfileTimeEvent | arg1 | ) |
Get the color assigned to the event.
Python Docstring:
GetColor( (FBProfileTimeEvent)arg1) -> FBColor
C++ Signature:
const float * GetColor()
| str GetComment | ( | FBProfileTimeEvent | arg1 | ) |
Get the comment for the event.
Python Docstring:
GetComment( (FBProfileTimeEvent)arg1) -> str
C++ Signature:
const char * GetComment()
Comments are not editable.
| int GetThreadID | ( | FBProfileTimeEvent | arg1 | ) |
Get the thread ID used in the event execution.
Python Docstring:
GetThreadID( (FBProfileTimeEvent)arg1) -> int
C++ Signature:
int GetThreadID()
| FBTime GetTime | ( | FBProfileTimeEvent | arg1 | ) |
Get the time when the event occurred.
Python Docstring:
GetTime( (FBProfileTimeEvent)arg1) -> FBTime
C++ Signature:
ORSDK2018::FBTime GetTime()
| str GetTypeName | ( | FBProfileTimeEvent | arg1 | ) |
Get the event registered type name.
Python Docstring:
GetTypeName( (FBProfileTimeEvent)arg1) -> str
C++ Signature:
const char * GetTypeName()
| bool IsSingleEvent | ( | FBProfileTimeEvent | arg1 | ) |
Three types of events exits: single, start and end.
Python Docstring:
IsSingleEvent( (FBProfileTimeEvent)arg1) -> bool
C++ Signature:
bool IsSingleEvent()
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.