editor › Globals › PerformanceTester

Class: PerformanceTester

Helper class that determines the performance (currently average FPS) of the renderer

Hierarchy

• PerformanceTester

Index

Constructors

• constructor

Properties

• actualAggregationTime
• aggregationTimeLeft
• canvasHeight
• canvasWidth
• enabled
• frameCounter
• metricsSubmittor
• waitTimeLeft

Methods

• setCanvasSize
• submitMetrics
• tick

Constructors

constructor

+ new PerformanceTester(metricsTarget: "console" | "influxdb"): PerformanceTester

Defined in src/renderContext/performance/PerformanceTester.ts:22

Parameters:

Name	Type	Default	Description
metricsTarget	"console" | "influxdb"	Config.get("performanceTesting.metricsTarget")	Defines where the metrics are to be sent. Currently allows for "console".

Returns: PerformanceTester

Properties

Private actualAggregationTime

• actualAggregationTime: number = 0

Defined in src/renderContext/performance/PerformanceTester.ts:16

---

Private aggregationTimeLeft

• aggregationTimeLeft: any = Config.get("performanceTesting.aggregationTime")

Defined in src/renderContext/performance/PerformanceTester.ts:15

---

Private canvasHeight

• canvasHeight: number = -1

Defined in src/renderContext/performance/PerformanceTester.ts:20

---

Private canvasWidth

• canvasWidth: number = -1

Defined in src/renderContext/performance/PerformanceTester.ts:19

---

Private enabled

• enabled: any = Config.get("performanceTesting.enabled", false)

Defined in src/renderContext/performance/PerformanceTester.ts:13

---

Private frameCounter

• frameCounter: number = 0

Defined in src/renderContext/performance/PerformanceTester.ts:17

---

Private metricsSubmittor

• metricsSubmittor: InfluxDbSubmitter | ConsoleMetricsSubmitter

Defined in src/renderContext/performance/PerformanceTester.ts:22

---

Private waitTimeLeft

• waitTimeLeft: any = Config.get("performanceTesting.initialWaitTime")

Defined in src/renderContext/performance/PerformanceTester.ts:14

Methods

setCanvasSize

▸ setCanvasSize(width: number, height: number): void

Defined in src/renderContext/performance/PerformanceTester.ts:40

Parameters:

Name	Type
width	number
height	number

Returns: void

---

submitMetrics

▸ submitMetrics(): void

Defined in src/renderContext/performance/PerformanceTester.ts:77

Submits the collected metrics

Returns: void

---

tick

▸ tick(timeDelta: number): void

Defined in src/renderContext/performance/PerformanceTester.ts:48

Called by renderer when a frame is being rendered

Parameters:

Name	Type
timeDelta	number

Returns: void