Packagesekati.profiler
Classpublic final class PerformanceMonitor

PerformanceMonitor provides a visual graph to application FPS and RAM usage.



Public Properties
 PropertyDefined by
  $ : PerformanceMonitor
[static][read-only] Shorthand singleton accessor getter
PerformanceMonitor
  averageFps : Number
[read-only] The average FPS.
PerformanceMonitor
  averageMem : Number
[read-only] The average RAM.
PerformanceMonitor
  currentFps : Number
[read-only] The current FPS.
PerformanceMonitor
  currentMem : Number
[read-only] The current global flashplayer memory usage.
PerformanceMonitor
  displaying : Boolean
[read-only] Determines whether the monitor is being displayed.
PerformanceMonitor
  fpsList : Array
PerformanceMonitor
  history : int = 60
PerformanceMonitor
  intervalTime : Number
[read-only] The interval at which the monitor is running.
PerformanceMonitor
  maxFps : Number
PerformanceMonitor
  maxMem : Number
PerformanceMonitor
  memList : Array
PerformanceMonitor
  minFps : Number
PerformanceMonitor
  minMem : Number
PerformanceMonitor
  running : Boolean
[read-only] Determines whether the monitor is running or not.
PerformanceMonitor
  runningTime : Number
[read-only] The amount of time the monitor has been running.
PerformanceMonitor
Public Methods
 MethodDefined by
  
PerformanceMonitor($:SingletonEnforcer = null)
PerformanceMonitor Singleton Constructor
PerformanceMonitor
  
[static] Singleton Accessor
PerformanceMonitor
  
hide():void
Hide the graph UI.
PerformanceMonitor
  
show():void
Show the graph UI.
PerformanceMonitor
  
start():void
Start monitoring.
PerformanceMonitor
  
stop():void
Stop monitoring.
PerformanceMonitor
  
Toggle the graph UI visibility.
PerformanceMonitor
  
Update the display & monitoring values.
PerformanceMonitor
  
updateMinMax():void
Update the monitoring values only.
PerformanceMonitor
Property detail
$property
$:PerformanceMonitor  [read-only]

Shorthand singleton accessor getter

Implementation
    public static function get $():PerformanceMonitor
averageFpsproperty 
averageFps:Number  [read-only]

The average FPS.

Implementation
    public function get averageFps():Number
averageMemproperty 
averageMem:Number  [read-only]

The average RAM.

Implementation
    public function get averageMem():Number
currentFpsproperty 
currentFps:Number  [read-only]

The current FPS.

Implementation
    public function get currentFps():Number
currentMemproperty 
currentMem:Number  [read-only]

The current global flashplayer memory usage.

Implementation
    public function get currentMem():Number
displayingproperty 
displaying:Boolean  [read-only]

Determines whether the monitor is being displayed.

Implementation
    public function get displaying():Boolean
fpsListproperty 
public var fpsList:Array
historyproperty 
public var history:int = 60
intervalTimeproperty 
intervalTime:Number  [read-only]

The interval at which the monitor is running.

Implementation
    public function get intervalTime():Number
maxFpsproperty 
public var maxFps:Number
maxMemproperty 
public var maxMem:Number
memListproperty 
public var memList:Array
minFpsproperty 
public var minFps:Number
minMemproperty 
public var minMem:Number
runningproperty 
running:Boolean  [read-only]

Determines whether the monitor is running or not.

Implementation
    public function get running():Boolean
runningTimeproperty 
runningTime:Number  [read-only]

The amount of time the monitor has been running.

Implementation
    public function get runningTime():Number
Constructor detail
PerformanceMonitor()constructor
public function PerformanceMonitor($:SingletonEnforcer = null)

PerformanceMonitor Singleton Constructor

Parameters
$:SingletonEnforcer (default = null) — SingletonEnforcer - internal to the AS file; the param prevents external instantiation without error.

Example
   PerformanceMonitor.$.show(); // display the graphical UI.
   

Method detail
getInstance()method
public static function getInstance():PerformanceMonitor

Singleton Accessor

Returns
PerformanceMonitor — PerformanceMonitor
hide()method 
public function hide():void

Hide the graph UI.

show()method 
public function show():void

Show the graph UI.

start()method 
public function start():void

Start monitoring.

stop()method 
public function stop():void

Stop monitoring.

toggleDisplay()method 
public function toggleDisplay():void

Toggle the graph UI visibility.

updateDisplay()method 
public function updateDisplay():void

Update the display & monitoring values.

updateMinMax()method 
public function updateMinMax():void

Update the monitoring values only.