Interface IXR_profiler

Source

namespace profiler

interface IXR_profiler {
    get_type(this: void): 0 | 1 | 2;
    is_active(this: void): boolean;
    log_report(this: void): void;
    log_report(this: void, entries_limit: number): void;
    reset(this: void): void;
    save_report(this: void): void;
    start(this: void): void;
    start(this: void, profiler_type: TXR_ProfilerType): void;
    start_hook_mode(this: void): void;
    start_sampling_mode(this: void): void;
    start_sampling_mode(this: void, sampling_interval: number): void;
    stop(this: void): void;
}

Methods

get_type is_active log_report reset save_report start start_hook_mode start_sampling_mode stop

Methods

get_type

  • get_type(this: void): 0 | 1 | 2

  • Parameters

    • this: void

    Returns 0 | 1 | 2

    currently active profiler type

is_active

  • is_active(this: void): boolean

  • Parameters

    • this: void

    Returns boolean

    whether lua scripts profiler is active

log_report

  • log_report(this: void): void

  • Log report of profiler measurements in game console/log file. Use default engine limit to print top N entries.

    Parameters

    • this: void

    Returns void

  • log_report(this: void, entries_limit: number): void

  • Log report of profiler measurements in game console/log file.

    Parameters

    • this: void
    • entries_limit: number

      limit of top profiling entries to print

    Returns void

reset

  • reset(this: void): void

  • Reset measurements data of profiler.

    Parameters

    • this: void

    Returns void

save_report

  • save_report(this: void): void

  • Save report of profiler measurements in corresponding log/perf file.

    Parameters

    • this: void

    Returns void

start

start_hook_mode

  • start_hook_mode(this: void): void

  • Start profiler in hook mode. Profiling performance based on lua call start/end events.

    Parameters

    • this: void

    Returns void

start_sampling_mode

  • start_sampling_mode(this: void): void

  • Start profiler in sampling mode with default sampling interval.

    Parameters

    • this: void

    Returns void

  • start_sampling_mode(this: void, sampling_interval: number): void

  • Start profiler in sampling mode with provided sampling interval value.

    Parameters

    • this: void
    • sampling_interval: number

      interval to collect samples with luaJIT sampling profiler

    Returns void

stop

Settings

Member Visibility

On This Page

Methods