Class ProfilerScriptEventsAbstract

Wrapper class to provide Profile Events functionality to scripting.

Hierarchy (view full)

Constructors

constructor

Methods

addAttribute addAttributeValues addEvent addEventSamples getAreStatsEnabledInScript getEnabledStats getIsProfilingEnabled getProfilerNanoseconds getProviderIdentifier getStatDifferential getStatValue register scriptFrameChanged scriptSynchronize unregister

Constructors

constructor

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

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

    Returns void

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

addEventSamples

  • addEventSamples(eventSampleData): void

  • Submits recorded event samples into profiler runtime database. Can be called only during profiler data synchronization.

    Parameters

    Returns void

getAreStatsEnabledInScript

  • getAreStatsEnabledInScript(): boolean

  • Returns boolean

getEnabledStats

getIsProfilingEnabled

  • getIsProfilingEnabled(): boolean

  • Returns boolean

getProfilerNanoseconds

  • getProfilerNanoseconds(): number

  • Returns current profiler time that should be used for sample measurements.

    Returns number

    Profiler time in nanoseconds.

getProviderIdentifier

  • getProviderIdentifier(): number

  • Returns identifier that was assigned to ProfielrScriptEvents profiler provider when it was registered in ProfilerRuntime.

    Returns number

    The provider identifier.

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

    Returns ProfilerStatValue

    Resulting stat value of the substraction operation.

getStatValue

register

  • register(): boolean

  • Registers the provider with the profiler runtime.

    Returns boolean

    False if the registration failed.

AbstractscriptFrameChanged

  • scriptFrameChanged(frameIdentifier): any
  • Virtual

    Script side of provider frame change.

    Parameters

    • frameIdentifier: number

      Identifier for the new frame.

    Returns any

AbstractscriptSynchronize

  • scriptSynchronize(): any
  • Virtual

    Script side of provider synchronization.

    Returns any

unregister

  • unregister(): boolean

  • Unregisters the provider with the profiler runtime.

    Returns boolean

    False if the unregistration failed.

Settings

Member Visibility

On This Page

Constructors
Methods