Class ProfilerGPU

Profiler that measures time and amount of various GPU operations.

Note

Core thread only except where noted otherwise.

Index

Constructors

Methods

getAggregateForCameraAsJSON getAvailableReportsCount getLatestReportOptionalAsJSON

Constructors

constructor

new ProfilerGPU(): ProfilerGPU
Returns ProfilerGPU

Methods

`Static`getAggregateForCameraAsJSON

getAggregateForCameraAsJSON(camera): JsonObject
Gets an aggregated GPU profiler report for a given camera. Returns an empty report if no reports are available for the camera.
Parameters
- camera: Camera
  The camera to generate an aggregate report for.
Returns JsonObject

`Static`getAvailableReportsCount

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.

`Static`getLatestReportOptionalAsJSON

getLatestReportOptionalAsJSON(): 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.

Returns JsonObject
Note
Thread safe.