Class GPUProfilerReportAggregate

A structure that contains aggregate information of a single frame rendering profiling results.

Note

Any changes here must be reflected in the ToJSON API in C++ and the corresponding TypeScript usage of the JSON object.

Index

Constructors

Properties

_frameBeginTime _frameIndex _renderedViewCount _timeMs _uiViewCount

Accessors

frameBeginTime frameIndex renderedViewCount timeMs uiViewCount

Methods

assign clone isEqual isEqual

Constructors

constructor

new GPUProfilerReportAggregate(
    frameIndex?: number,
    frameBeginTime?: number,
    timeMs?: number,
    renderedViewCount?: number,
    uiViewCount?: number,
): GPUProfilerReportAggregate
Parameters
- OptionalframeIndex: number
- OptionalframeBeginTime: number
- OptionaltimeMs: number
- OptionalrenderedViewCount: number
- OptionaluiViewCount: number
Returns GPUProfilerReportAggregate

Properties

`Protected`_frameBeginTime

_frameBeginTime: number

`Protected`_frameIndex

_frameIndex: number

`Protected`_renderedViewCount

_renderedViewCount: number

`Protected`_timeMs

_timeMs: number

`Protected`_uiViewCount

_uiViewCount: number

Accessors

frameBeginTime

get frameBeginTime(): number

Records the time the frame started recording.

Returns number
set frameBeginTime(value: number): void
Parameters
- value: number
Returns void

frameIndex

get frameIndex(): number

The frame index the report was recorded from.

Returns number
set frameIndex(value: number): void
Parameters
- value: number
Returns void

renderedViewCount

get renderedViewCount(): number

Indicates the number of views rendered in this frame.

Returns number
set renderedViewCount(value: number): void
Parameters
- value: number
Returns void

timeMs

get timeMs(): number

Time in milliseconds it took to all GPU commands in the frame

Returns number
set timeMs(value: number): void
Parameters
- value: number
Returns void

uiViewCount

get uiViewCount(): number

Indicates the number of UI-only views rendered in this frame.

Returns number
set uiViewCount(value: number): void
Parameters
- value: number
Returns void

Methods

assign

assign(other: Immutable<GPUProfilerReportAggregate>): GPUProfilerReportAggregate
Copies all properties defined by the prototype of GPUProfilerReportAggregate from other to this instance.
Parameters
- other: Immutable<GPUProfilerReportAggregate>
Returns GPUProfilerReportAggregate

clone

clone(): GPUProfilerReportAggregate

Clones this instance and returns a new GPUProfilerReportAggregate with identical values.

Returns GPUProfilerReportAggregate

isEqual

isEqual(
this: Immutable<GPUProfilerReportAggregate>,
other: Immutable<GPUProfilerReportAggregate>,
): boolean
Determines if this GPUProfilerReportAggregate instance is equal to the other instance.
Parameters
- this: Immutable<GPUProfilerReportAggregate>
- other: Immutable<GPUProfilerReportAggregate>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<GPUProfilerReportAggregate>,
rhs: Immutable<GPUProfilerReportAggregate>,
): boolean
Determines if both GPUProfilerReportAggregate instances are equal.
Parameters
- lhs: Immutable<GPUProfilerReportAggregate>
- rhs: Immutable<GPUProfilerReportAggregate>
Returns boolean