PerformanceEvent

Inherits from MetricEvent

Summary

Constructors

PerformanceEvent()
PerformanceEvent(guid: Guid)
PerformanceEvent(other: MetricEvent)
PerformanceEvent(other: DataContainer)

Properties

Name Type
position Vec3
freeCPUMemory float
cpuAverage float
allocCPUMemory float
freeGPUMemory float
gpuAverage float
drawCallCount int
primitiveCount int
allocGPUMemory float
performanceLocation string
performanceLink Guid

Static members

Name Type
PerformanceEvent.typeInfo TypeInformation

Constructors

PerformanceEvent

PerformanceEvent()

Creates a new PerformanceEvent frostbite instance.

PerformanceEvent

PerformanceEvent(guid: Guid)

Creates a new PerformanceEvent frostbite instance and assigns it the provided Guid.

Parameters

Name Type Description
guid Guid The Guid to assign to the newly created instance.

PerformanceEvent

PerformanceEvent(other: MetricEvent)

Casts an instance of type MetricEvent to PerformanceEvent. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other MetricEvent The instance to cast to PerformanceEvent.

PerformanceEvent

PerformanceEvent(other: DataContainer)

Casts an instance of type DataContainer to PerformanceEvent. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other DataContainer The instance to cast to PerformanceEvent.

Properties

position

Vec3

freeCPUMemory

float

cpuAverage

float

allocCPUMemory

float

freeGPUMemory

float

gpuAverage

float

drawCallCount

int

primitiveCount

int

allocGPUMemory

float

performanceLocation

string

Guid

Static members

typeInfo

TypeInformation

The type information for the PerformanceEvent type.

Last modified April 26, 2020: Update frostbite type documentation (8b14351)