Class PooledProfilerScriptEvents

The PooledProfilerScriptEvents class is a central class in script domain that gathers data from profiling before moving them to native storage.

Hierarchy (view full)

ProfilerScriptEvents
- PooledProfilerScriptEvents

Constructors

constructor

new PooledProfilerScriptEvents(): PooledProfilerScriptEvents
Sets up everything needed for an active script events provider.

Returns PooledProfilerScriptEvents
Overrides ProfilerScriptEvents.constructor

Properties

`Protected` `Readonly`_attributeValues

_attributeValues: ProfilerAttributeValue[]

`Protected` `Readonly`_eventSamples

_eventSamples: ProfilerEventSample[]

`Protected`_frameIdentifier

_frameIdentifier: number

`Protected`_nextEventSampleIdentifier

_nextEventSampleIdentifier: number

`Protected` `Readonly`_stopwatch

_stopwatch: Stopwatch

`Protected`_stopwatchProfilerOffsetNanoseconds

_stopwatchProfilerOffsetNanoseconds: number

Add this to nanoseconds from _stopwatch to get profiler time specified by profiler runtime.

areStatsEnabledInScript

areStatsEnabledInScript: boolean

Enables recording of profiler stats in script events. This typically requires a script -> C++ interop call, which might affect pefromance, so it is disabled by default.

enabledStats

enabledStats: ProfilerDatabaseIdentifier[]

Collection of profiler stats that should be captured during profiling.

isProfilingEnabled

isProfilingEnabled: boolean

Runtime should continuously capture profiling data, but data older than last frame can be automatically removed.

`Protected` `Static` `Readonly`_attributes

_attributes: ProfilerAttribute[]

`Protected` `Static` `Readonly`_events

_events: ProfilerEvent[]

`Protected` `Static`_nextAttributeIdentifier

_nextAttributeIdentifier: number

`Protected` `Static`_nextEventIdentifier

_nextEventIdentifier: number

`Static`instance

instance: PooledProfilerScriptEvents

Pointer to a singleton instance of profiler script events.

Methods

addAttribute

addAttribute(identifier, name): void
Submits attribute definition into profiler runtime database. Can be called only during profiler data synchronization.
Parameters
- identifier: number
  Unique identifier of the attribute definition.
- name: string
  User-friendly name for the attribute.
Returns void
Inherited from ProfilerScriptEvents.addAttribute

addAttributeValue

addAttributeValue(attributeValue): void
If the attribute value is active, this will synchronize it into profiler runtime database at the end of frame. Both active and inactive attribute value instances will be returned into attribute value instance pool after synchronizations.
Parameters
- attributeValue: ProfilerAttributeValue
  New attribute value emitted by profiled code.
Returns void

addAttributeValues

addAttributeValues(attributeValueData): void
Submits recorded attribute values into profiler runtime database. These will be assigned to the correct event samples. Can be called only during profiler data synchronization.
Parameters
- attributeValueData: Immutable<AttributeValueData>[]
  Array with attribute value data.
Returns void
Inherited from ProfilerScriptEvents.addAttributeValues

addEvent

addEvent(identifier, name): void
Submits event definition into profiler runtime database. Can be called only during profiler data synchronization.
Parameters
- identifier: number
  Unique identifier of the event definition.
- name: string
  User-friendly name for the event.
Returns void
Inherited from ProfilerScriptEvents.addEvent

addEventSample

addEventSample(eventSample): void
If the event sample is active, this will synchronize it into profiler runtime database at the end of frame. Both active and inactive event sample instances will be returned into event sample instance pool after synchronizations.
Parameters
- eventSample: ProfilerEventSample
  New event sample emitted by profiled code.
Returns void

addEventSamples

addEventSamples(eventSampleData): void
Submits recorded event samples into profiler runtime database. Can be called only during profiler data synchronization.
Parameters
- eventSampleData: Immutable<EventSampleData>[]
  Array with event sample data.
Returns void
Inherited from ProfilerScriptEvents.addEventSamples

getAreStatsEnabledInScript

getAreStatsEnabledInScript(): boolean
Returns boolean
Inherited from ProfilerScriptEvents.getAreStatsEnabledInScript

getEnabledStats

getEnabledStats(): ProfilerDatabaseIdentifier[]
Returns ProfilerDatabaseIdentifier[]
Inherited from ProfilerScriptEvents.getEnabledStats

getFrameIdentifier

getFrameIdentifier(): number
Returns identifier of the current frame according to profiler runtime.

Returns number
Current frame identifier.

getIsProfilingEnabled

getIsProfilingEnabled(): boolean
Returns boolean
Inherited from ProfilerScriptEvents.getIsProfilingEnabled

getNextEventSampleIdentifier

getNextEventSampleIdentifier(): number
Returns identifier to be associated with new event sample.

Returns number
New event sample identifier.

getProfilerNanoseconds

getProfilerNanoseconds(): number
Returns current profiler time that should be used for sample measurements.

Returns number
Profiler time in nanoseconds.

Inherited from ProfilerScriptEvents.getProfilerNanoseconds

getProfilerTime

getProfilerTime(): number
Returns best estimate for current time defined by profiler runtime.

Returns number
Current profiler time to be used by sample measurements.

getProviderIdentifier

getProviderIdentifier(): number
Returns identifier that was assigned to ProfielrScriptEvents profiler provider when it was registered in ProfilerRuntime.

Returns number
The provider identifier.

Inherited from ProfilerScriptEvents.getProviderIdentifier

getStatDifferential

getStatDifferential(begin, end): ProfilerStatValue
Returns a new value that represents a change in value between between two values from two different time points. This basically substracts given end value from given begin value.
Parameters
- begin: Immutable<ProfilerStatValue>
  Value of first time point.
- end: Immutable<ProfilerStatValue>
  Value of the second time point.
Returns ProfilerStatValue
Resulting stat value of the substraction operation.

Inherited from ProfilerScriptEvents.getStatDifferential

getStatValue

getStatValue(statIdentifier): ProfilerStatValue
Returns current value of given profiler stat.
Parameters
- statIdentifier: Immutable<ProfilerDatabaseIdentifier>
  Identifier of the stat to read.
Returns ProfilerStatValue
Current value of the profiler stat.

Inherited from ProfilerScriptEvents.getStatValue

register

register(): boolean
Registers the provider with the profiler runtime.

Returns boolean
False if the registration failed.

Inherited from ProfilerScriptEvents.register

scriptFrameChanged

scriptFrameChanged(frameIdentifier): void
Called from native code to inform provider about new frame being started and to update profiling configuration.
Parameters
- frameIdentifier: number
  Identifier to be used for following frame.
Returns void
Overrides ProfilerScriptEvents.scriptFrameChanged

scriptSynchronize

scriptSynchronize(): void
Called from native code to trigger synchronization of captured data back into profiler runtime.

Returns void
Overrides ProfilerScriptEvents.scriptSynchronize

unregister

unregister(): boolean
Unregisters the provider with the profiler runtime.

Returns boolean
False if the unregistration failed.

Inherited from ProfilerScriptEvents.unregister

`Static`addAttribute

addAttribute(attribute): void
Adds attribute definition to be synchronized into profiler runtime at the end of frame.
Parameters
- attribute: ProfilerAttribute
  New profiler attribute to be added to database.
Returns void

`Static`addEvent

addEvent(profilerEvent): void
Adds event definition to be synchronized into profiler runtime at the end of frame.
Parameters
- profilerEvent: ProfilerEvent
  New profiler event to be added to database.
Returns void

`Static`getNextAttributeIdentifier

getNextAttributeIdentifier(): number
Returns identifier to be associated with new attribute definition.

Returns number
New attribute identifier.

`Static`getNextEventIdentifier

getNextEventIdentifier(): number
Returns identifier to be associated with new event definition.

Returns number
New event identifier.

`Static`setInstance

setInstance(provider): void
Sets singleton instance of profiler script events. This should be called only once after module reload.
Parameters
- provider: PooledProfilerScriptEvents
  Provider instance that will be used as singleton instance.
Returns void

Class PooledProfilerScriptEvents

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PooledProfilerScriptEvents

Properties

Protected Readonly_attributeValues

Protected Readonly_eventSamples

Protected_frameIdentifier

Protected_nextEventSampleIdentifier

Protected Readonly_stopwatch

Protected_stopwatchProfilerOffsetNanoseconds

areStatsEnabledInScript

enabledStats

isProfilingEnabled

Protected Static Readonly_attributes

Protected Static Readonly_events

Protected Static_nextAttributeIdentifier

Protected Static_nextEventIdentifier

Staticinstance

Methods

addAttribute

Parameters

Returns void

addAttributeValue

Parameters

Returns void

addAttributeValues

Parameters

Returns void

addEvent

Parameters

Returns void

addEventSample

Parameters

Returns void

addEventSamples

Parameters

Returns void

getAreStatsEnabledInScript

Returns boolean

getEnabledStats

Returns ProfilerDatabaseIdentifier[]

getFrameIdentifier

Returns number

getIsProfilingEnabled

Returns boolean

getNextEventSampleIdentifier

Returns number

getProfilerNanoseconds

Returns number

getProfilerTime

Returns number

getProviderIdentifier

Returns number

getStatDifferential

Parameters

Returns ProfilerStatValue

getStatValue

Parameters

Returns ProfilerStatValue

register

Returns boolean

scriptFrameChanged

Parameters

Returns void

scriptSynchronize

Returns void

unregister

Returns boolean

StaticaddAttribute

Parameters

Returns void

StaticaddEvent

Parameters

Returns void

`Protected` `Readonly`_attributeValues

`Protected` `Readonly`_eventSamples

`Protected`_frameIdentifier

`Protected`_nextEventSampleIdentifier

`Protected` `Readonly`_stopwatch

`Protected`_stopwatchProfilerOffsetNanoseconds

`Protected` `Static` `Readonly`_attributes

`Protected` `Static` `Readonly`_events

`Protected` `Static`_nextAttributeIdentifier

`Protected` `Static`_nextEventIdentifier

`Static`instance

`Static`addAttribute

`Static`addEvent

`Static`getNextAttributeIdentifier

`Static`getNextEventIdentifier

`Static`setInstance