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

    Class ProfilerTools

    The ProfilerTools class contains various helper methods that should allow us to quickly and simply control some common profiler functions. It is mainly intended for use from script with simple UI controls or for another quick testing purposes. Scalable and comprihensive solutions should implement ProfilerClient directly and use ProfilerIndex for data preprocessing.

    Index
    • Parameters

      • OptionalisInternalConstructor: boolean

      Returns ProfilerTools

    • Enables capturing for one frame, then exports data to given path. It also clears the database before and after that.

      Parameters

      • pathTemplate: string

        Filepath that will be extended with a number so that existing files are not overwritten.

      Returns void

    • Clears all profiling data captured so far.

      Returns void

    • Exports captured profiling data into Google Chromes chrome:tracing json format.

      Parameters

      • path: string

        Filepath to file that will be written.

      Returns void

    • Exports captured profiling data into Google Chrome about:tracing json format.

      Parameters

      • pathTemplate: string

        Filepath that will be extended with a number so that existing files are not overwritten.

      Returns string

      Actual filename of file that was created or empty string if export failed.

    • Starts capturing profiling data.

      Returns void

    • Stops profiling capture started with .

      Returns void