Class ScriptProfilerClient

Mediates communication between ProfilerRuntime in C++ and ProfilerWindow in TypeScript. Allows ProfilerWindow to control the profiling process and then receive the resulting data.

Hierarchy

FrameworkObject
- ScriptProfilerClient

Index

Constructors

Methods

clampDatabase clampDatabaseAutomatically enableProfiling enableStatsInScript filterDataByRootFrame getCurrentFrameIdentifier getCurrentNanoseconds getDataRange getLocalIndex isProfilingEnabled moveEntriesToIndex self setup

Constructors

constructor

new ScriptProfilerClient(isInternalConstructor?): ScriptProfilerClient
Plain constructor.
Parameters
- OptionalisInternalConstructor: boolean
Returns ScriptProfilerClient
Overrides FrameworkObject.constructor

Methods

clampDatabase

clampDatabase(preservedRange): void
Removes some data from the beginning and end of profiling so that there aren't incomplete call stacks (with missing parent samples) in resulting flamegraph.
Parameters
- preservedRange: Immutable<ProfilerTimeRange>
  Range in profiler nanoseconds in which data should be preserved.
Returns void

clampDatabaseAutomatically

clampDatabaseAutomatically(): void
Removes some data from the beginning and end of profiling so that there aren't incomplete call stacks (with missing parent samples) in resulting flamegraph.

Returns void

enableProfiling

enableProfiling(enable): void
Configures if client should request ProfilerRuntime to perform profiling and send profiled data to it.
Parameters
- enable: boolean
  True if profiling should be running, false otherwise.
Returns void

enableStatsInScript

enableStatsInScript(enable): void
Configures if script events should capture values of stats.
Parameters
- enable: boolean
  True if stats should be enabled, false otherwise.
Returns void

filterDataByRootFrame

filterDataByRootFrame(frameIdentifier): void
Removes all samples from database except for samples that are inside a root sample with frame identifier that is listed in given array.
Parameters
- frameIdentifier: number
Returns void

getCurrentFrameIdentifier

getCurrentFrameIdentifier(): number
Returns current frame identifier from profiler runtime.

Returns number

getCurrentNanoseconds

getCurrentNanoseconds(): number
Returns current time according to profiler runtime.

Returns number
Current profiler time in nanoseconds.

getDataRange

getDataRange(): ProfilerTimeRange
Gets time range containing data available in database.

Returns ProfilerTimeRange
Time range of data in database.

getLocalIndex

getLocalIndex(): ProfilerIndex
Returns profiler index containing data captured during profiling of this RSX Framework process.

Returns ProfilerIndex

isProfilingEnabled

isProfilingEnabled(): boolean
Returns boolean value telling us whether profiling is enabled on this profiler client.

Returns boolean
True if profiling is currently enabled.

moveEntriesToIndex

moveEntriesToIndex(): void
If ProfilerDatabase contains any data, these will be moved to ProfilerIndex. This also clamps begin and end of the data, so this should not be used to continuously insert incoming data.

Returns void

self

self(): ScriptProfilerClient
This is here to trigger script bindings generator to include this file from the script bindings. The inclusion does not seem to be triggered by exporting functions with Shared or Vector.

Returns ScriptProfilerClient

`Static`setup

setup(self): void
Registers profiler client into ProfilerRuntime and ProfilerDatabase to get callbacks about incoming data. This is static instead of member so that we get the Shared pointer, which is needed for registration to profiler.
Parameters
- self: ScriptProfilerClient
  Pointer to the profiler client that should be registered into profiler runtime.
Returns void