Class ProfilerGPU

Profiler that measures time and amount of various GPU operations.

Index

Constructors

Methods

getAvailableReportsCount getCameraReport getLatestReport

Constructors

constructor

new ProfilerGPU(): ProfilerGPU

Returns ProfilerGPU

Inherited from ProfilerGPUGenerated.constructor

Methods

`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.

Inherited from ProfilerGPUGenerated.getAvailableReportsCount

`Static`getCameraReport

getCameraReport(camera: Camera, includeChildSamples: boolean): 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.

Inherited from ProfilerGPUGenerated.getCameraReport

`Static`getLatestReport

getLatestReport(includeChildSamples: boolean): 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.

Inherited from ProfilerGPUGenerated.getLatestReport