Class: PerformanceWatchdogViewModel

PerformanceWatchdogViewModel

new PerformanceWatchdogViewModel(optionsopt)

The view model for PerformanceWatchdog.
Parameters:
Name Type Attributes Description
options Object <optional>
 Object with the following properties:
Properties
Name Type Attributes Default Description
scene Scene The Scene instance for which to monitor performance.
lowFrameRateMessage String <optional>
 'This application appears to be performing poorly on your system. Please try using a different web browser or updating your video drivers.' The message to display when a low frame rate is detected. The message is interpeted as HTML, so make sure it comes from a trusted source so that your application is not vulnerable to cross-site scripting attacks.
Source:

Members

dismissMessage :Command

Gets a command that dismisses the low frame rate message. Once it is dismissed, the message will not be redisplayed.
Type:
Source:

lowFrameRateMessage :String

Gets or sets the message to display when a low frame rate is detected. This string will be interpreted as HTML.
Type:
  • String
Source:

lowFrameRateMessageDismissed :Boolean

Gets or sets a value indicating whether the low frame rate message has previously been dismissed by the user. If it has been dismissed, the message will not be redisplayed, no matter the frame rate.
Type:
  • Boolean
Source:

scene :Scene

Gets the Scene instance for which to monitor performance.
Type:
Source:

showingLowFrameRateMessage :Boolean

Gets or sets a value indicating whether the low frame rate message is currently being displayed.
Type:
  • Boolean
Source: