RSX Code Reference
    Preparing search index...
    • rsx
    • ProfilerScriptEvents

    Class ProfilerScriptEventsAbstract

    Wrapper class to provide Profile Events functionality to scripting.

    Hierarchy (View Summary)

    Index
    • 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

    • 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

    • 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

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

      Parameters

      Returns void

    • Returns boolean

    • Returns boolean

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

      Returns number

      Profiler time in nanoseconds.

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

      Returns number

      The provider identifier.

    • Registers the provider with the profiler runtime.

      Returns boolean

      False if the registration failed.

    • Virtual

      Script side of provider frame change.

      Parameters

      • frameIdentifier: number

        Identifier for the new frame.

      Returns any

    • Virtual

      Script side of provider synchronization.

      Returns any

    • Unregisters the provider with the profiler runtime.

      Returns boolean

      False if the unregistration failed.