Class ProfilerEventSample

The ProfilerEventSample class contains captured data for an event.

Constructors

Properties

active: boolean

Whether the sample was measured or is currently beagin measured. If this is false, nothing will be measured and sample will not be submitted to profiler runtime.

frameIdentifier: number

Identifiers frame when the sample started measuring.

identifier: number

Identifier of the specific captured event sample.

nanosecondsBegin: number

Time when the sample started capturing, in nanoseconds from origin defined by ProfilerRuntime.

nanosecondsEnd: number

Time when the sample stopped capturing, in nanoseconds from origin defined by ProfilerRuntime.

profilerEvent: ProfilerEvent

Reference to definition of the event that is being captured in this sample.

Stat data recorded by the script event.

statsUsed: number

Number of stats at the beginning of the Stats list that is actually used.

Methods

  • This version of SetAttribute function has better performance because it the attribute definition is explicitly provided.

    Parameters

    • attribute: ProfilerAttribute

      Definition of the attribute.

    • value: any

      Value to be assigned to the attribute. Recognized types are int, float and string, other types are converted to string using their toString() method.

    Returns void

  • This version of SetAttribute function has slightly worse performance because it searches for given attribute definition by string name.

    Parameters

    • attribute: string

      Name of the attribute.

    • value: any

      Value to be assigned to the attribute. Recognized types are int, float and string, other types are converted to string using their toString() method.

    Returns void

  • Starts event sample time measurement.

    Parameters

    • profilerEvent: ProfilerEvent

      Event that is being measured by this event sample.

    Returns void

  • Stop measuring sample, submit it to profiler provider and then return this instance to instance pool.

    Returns void

  • Returns event sample instance back to static pool so that it can be reused again.

    Parameters

    Returns void