startFullScreen(antialias, allowTrampoline) → {boolean}
Start the browsers fullscreen mode - this must be called from a user input Pointer or Mouse event.
The Fullscreen API must be supported by the browser for this to work - it is not the same as setting
the game size to fill the browser window. See compatibility.supportsFullScreen to check if the current
device is reported to support fullscreen mode.
The fullScreenFailed signal will be dispatched if the fullscreen change request failed or the game does not support the Fullscreen API.
Parameters
| Name | Type | Argument | Description |
|---|---|---|---|
antialias | boolean | <optional> | Changes the anti-alias feature of the canvas before jumping in to fullscreen (false = retain pixel art, true = smooth art). If not specified then no change is made. Only works in CANVAS mode. |
allowTrampoline | boolean | <optional> | Internal argument. If |
Returns
Returns true if the device supports fullscreen mode and fullscreen mode was attempted to be started. (It might not actually start, wait for the signals.)
- Source code: core/ScaleManager.js (Line 1749)
Please login to continue.