Class ProfilerGPU

Profiler that measures time and amount of various GPU operations.

Constructors

constructor

Methods

getAvailableReportsCount getCameraReport getLatestReport

Constructors

constructor

Methods

StaticgetAvailableReportsCount

  • getAvailableReportsCount(): number

  • Returns number of profiling reports that are ready but haven't been retrieved yet.

    Returns number

    Note

    There is an internal limit of maximum number of available reports, where oldest ones will get deleted so make sure to call this often if you don't want to miss some.

    Note

    Thread safe.

StaticgetCameraReport

  • getCameraReport(camera, includeChildSamples): JsonObject

  • Gets the latest GPU profiler report for a given camera.

    Parameters

    • camera: Camera

      The camera to generate an aggregate report for.

    • includeChildSamples: boolean

      If true, child samples will be included in the report.

    Returns JsonObject

    The GPU profiler report in JSON format, or an empty optional if no report is available.

StaticgetLatestReport

  • getLatestReport(includeChildSamples): JsonObject

  • Gets the latest report available. Keeps the returned report on the buffer. Returns an empty report if no reports are available. Same as GetLatestReportOptional(), but returns the report in JSON format.

    Parameters

    • includeChildSamples: boolean

    Returns JsonObject

    Note

    Thread safe.

Settings

Member Visibility

On This Page

Constructors
Methods