editor › Globals › FidelityControl

Class: FidelityControl

This class changes the fidelity in order to compensate for missing compute resources

Hierarchy

• FidelityControl

Index

Constructors

• constructor

Properties

• currentDelay
• currentMode
• enabled
• framesBeyondThreshold
• lowerFPSThreshold
• maxFramesBeyondThreshold
• totalAverage
• upperFPSThreshold
• windowSize
• availableModes

Methods

• _getDefaultCurrentMode
• _getPrefixedFidelityIdentifier
• _reset
• _switchMode
• setEnabled
• updateFidelity

Constructors

constructor

+ new FidelityControl(windowSize: any, totalAverage: FloatingAverage‹›, lowerFPSThreshold: any, upperFPSThreshold: any, maxFramesBeyondThreshold: any, enabled: any): FidelityControl

Defined in src/renderContext/FidelityControl.ts:16

Parameters:

Name	Type	Default
windowSize	any	Config.get("fidelityControl.observationWindowSize")
totalAverage	FloatingAverage‹›	new FloatingAverage(windowSize)
lowerFPSThreshold	any	Config.get("fidelityControl.lowerFPSThreshold")
upperFPSThreshold	any	Config.get("fidelityControl.upperFPSThreshold")
maxFramesBeyondThreshold	any	Config.get("fidelityControl.maxFramesBeyondThreshold")
enabled	any	Config.get("fidelityControl.enabled")

Returns: FidelityControl

Properties

Private currentDelay

• currentDelay: number

Defined in src/renderContext/FidelityControl.ts:15

---

Private currentMode

• currentMode: number

Defined in src/renderContext/FidelityControl.ts:14

---

Private enabled

• enabled: any

Defined in src/renderContext/FidelityControl.ts:27

---

Private framesBeyondThreshold

• framesBeyondThreshold: number

Defined in src/renderContext/FidelityControl.ts:16

---

Private Readonly lowerFPSThreshold

• lowerFPSThreshold: any

Defined in src/renderContext/FidelityControl.ts:22

---

Private Readonly maxFramesBeyondThreshold

• maxFramesBeyondThreshold: any

Defined in src/renderContext/FidelityControl.ts:25

---

Private Readonly totalAverage

• totalAverage: FloatingAverage‹›

Defined in src/renderContext/FidelityControl.ts:20

---

Private Readonly upperFPSThreshold

• upperFPSThreshold: any

Defined in src/renderContext/FidelityControl.ts:23

---

Private Readonly windowSize

• windowSize: any

Defined in src/renderContext/FidelityControl.ts:19

---

Static availableModes

▪ availableModes: string[] = ["lowestFidelity", "lowFidelity", "mediumFidelity", "highFidelity", "ultraFidelity"]

Defined in src/renderContext/FidelityControl.ts:13

Methods

Private _getDefaultCurrentMode

▸ _getDefaultCurrentMode(): number

Defined in src/renderContext/FidelityControl.ts:82

Returns: number

index of the current mode that should be used by default for this specific device

---

Private _getPrefixedFidelityIdentifier

▸ _getPrefixedFidelityIdentifier(): string

Defined in src/renderContext/FidelityControl.ts:101

Returns: string

---

Private _reset

▸ _reset(): void

Defined in src/renderContext/FidelityControl.ts:105

Returns: void

---

Private _switchMode

▸ _switchMode(modeDirection: -1 | 0 | 1): void

Defined in src/renderContext/FidelityControl.ts:92

Parameters:

Name	Type
modeDirection	-1 | 0 | 1

Returns: void

---

setEnabled

▸ setEnabled(enabled: boolean): void

Defined in src/renderContext/FidelityControl.ts:33

Parameters:

Name	Type
enabled	boolean

Returns: void

---

updateFidelity

▸ updateFidelity(delta: number, wasSleeping: boolean): void

Defined in src/renderContext/FidelityControl.ts:42

Receives time since last frame and may update the fidelity

Parameters:

Name	Type	Default	Description
delta	number	-	-milliseconds since last frame
wasSleeping	boolean	false	is this frame after a wakeup?

Returns: void