IProfiler#

class carb.profiler.IProfiler#

Bases: pybind11_object

Methods

`__init__`(args, *kwargs)
`begin`(self, mask, name)
`end`(self, mask)
`ensure_thread`(self)	Ensures that the profiler is aware of a Python thread.
`flow`(self, arg0, arg1, arg2, arg3)
`frame`(self, arg0, arg1)
`get_capture_mask`(self)
`instant`(self, arg0, arg1, arg2)
`is_python_profiling_enabled`(self)	Returns whether Python cProfile-level profiling is enabled.
`set_capture_mask`(self, mask)
`set_python_profiling_enabled`(self, enable)	Enables or disables cProfile-level Python profiling.
`shutdown`(self)
`startup`(self)
`value_float`(self, mask, value, name)
`value_int`(self, mask, value, name)
`value_uint`(self, mask, value, name)

__init__(*args, **kwargs)#

begin( self: carb.profiler._profiler.IProfiler, mask: int, name: str, ) → None#

end( self: carb.profiler._profiler.IProfiler, mask: int, ) → None#

ensure_thread( self: carb.profiler._profiler.IProfiler, ) → None#

Ensures that the profiler is aware of a Python thread.

If the profiler is already aware of the Python thread, there is no effect.

Parameters:: None
Returns:: None

flow( self: carb.profiler._profiler.IProfiler, arg0: int, arg1: carb.profiler._profiler.FlowType, arg2: int, arg3: str, ) → None#

frame( self: carb.profiler._profiler.IProfiler, arg0: int, arg1: str, ) → None#

get_capture_mask( self: carb.profiler._profiler.IProfiler, ) → int#

instant( self: carb.profiler._profiler.IProfiler, arg0: int, arg1: carb.profiler._profiler.InstantType, arg2: str, ) → None#

is_python_profiling_enabled( self: carb.profiler._profiler.IProfiler, ) → bool#

Returns whether Python cProfile-level profiling is enabled.

Returns:: True if Python function profiling is enabled, False otherwise.

set_capture_mask( self: carb.profiler._profiler.IProfiler, mask: int, ) → int#

set_python_profiling_enabled( self: carb.profiler._profiler.IProfiler, enable: bool, ) → None#

Enables or disables cProfile-level Python profiling.

Enabling this value causes every Python function call to be recorded through carb.profiler. As such, it can negatively affect performance and can lead to very large profiler files.

Only Python threads that carb.profiler is aware of will report to the profiler. Calling ensure_thread() will ensure that carb.profiler is aware of a Python thread.

Use is_python_profiling_enabled() to determine the current state of this value.

Parameters:: enable – True to enable the profiler or False to disable.
Returns:: None

shutdown(self: carb.profiler._profiler.IProfiler) → None#

startup(self: carb.profiler._profiler.IProfiler) → None#

value_float( self: carb.profiler._profiler.IProfiler, mask: int, value: float, name: str, ) → None#

value_int( self: carb.profiler._profiler.IProfiler, mask: int, value: int, name: str, ) → None#

value_uint( self: carb.profiler._profiler.IProfiler, mask: int, value: int, name: str, ) → None#