ProfileRecorderPlugin
Defined in: app/profileRecorder.ts:151
Installs a ProfileRecorder and hands it to the game. Recording is NOT started: a shipped build pays for the instrumentation only from the moment something asks it to.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ProfileRecorderPlugin(
options_?,onReady_?):ProfileRecorderPlugin
Defined in: app/profileRecorder.ts:156
Parameters
Section titled “Parameters”options_?
Section titled “options_?”onReady_?
Section titled “onReady_?”(recorder) => void
Returns
Section titled “Returns”ProfileRecorderPlugin
Properties
Section titled “Properties”
readonlyname:"profileRecorder"='profileRecorder'
Defined in: app/profileRecorder.ts:152
Implementation of
Section titled “Implementation of”profileDomain
Section titled “profileDomain”
readonlyprofileDomain:"diagnostics"='diagnostics'
Defined in: app/profileRecorder.ts:153
Cost domain the profiler files this plugin’s systems under. Defaults to
name; declare it where the two differ, as camera producing render.
Implementation of
Section titled “Implementation of”Accessors
Section titled “Accessors”recorder
Section titled “recorder”Get Signature
Section titled “Get Signature”get recorder():
ProfileRecorder|null
Defined in: app/profileRecorder.ts:162
The recorder, once the plugin has been built into an App.
Returns
Section titled “Returns”ProfileRecorder | null
Methods
Section titled “Methods”build()
Section titled “build()”build(
app):void
Defined in: app/profileRecorder.ts:166
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”cleanup()
Section titled “cleanup()”cleanup():
void
Defined in: app/profileRecorder.ts:171
Returns
Section titled “Returns”void