Rates

Description

Supported Script Types:

  • Interface Scripts
  • Client Entity Scripts
  • Avatar Scripts
The Rates API provides some information on current rendering performance.

Example

Report current rendering rates.

// The rates to report.
var rates = [
    "render",
    "present",
    "newFrame",
    "dropped",
    "simulation"
];

// Report the rates.
for (var i = 0; i < rates.length; i++) {
    print("Rates." + rates[i], "=", Rates[rates[i]]);
}
 

Properties

Name Type Summary
render number

The rate at which new GPU frames are being created, in Hz. Read-only.

present number

The rate at which the display plugin is presenting to the display device, in Hz. Read-only.

newFrame number

The rate at which the display plugin is presenting new GPU frames, in Hz. Read-only.

dropped number

The rate at which the display plugin is dropping GPU frames, in Hz. Read-only.

simulation number

The rate at which the game loop is running, in Hz. Read-only.