<internal> new Device()
It is not possible to instantiate the Device class manually.
- Internal:
- This member is internal (protected) and may be modified or removed in the future.
- Source code: system/Device.js (Line 30)
Public Properties
-
<static, nullable> onInitialized : Phaser.Signal
-
This signal is dispatched after device initialization occurs but before any of the ready callbacks (see whenReady) have been invoked.
Local "patching" for a particular device can/should be done in this event.
Note: This signal is removed after the device has been readied; if a handler has not been added before
new Phaser.Game(..)
it is probably too late.- Source code: system/Device.js (Line 544)
-
android : boolean
-
Is running on android?
- Source code: system/Device.js (Line 118)
-
arora : boolean
-
Set to true if running in Arora.
- Source code: system/Device.js (Line 257)
-
audioData : boolean
-
Are Audio tags available?
- Source code: system/Device.js (Line 367)
-
cancelFullscreen : string
-
If the browser supports the Full Screen API this holds the call you need to use to cancel it.
- Source code: system/Device.js (Line 518)
-
canvas : boolean
-
Is canvas available?
- Source code: system/Device.js (Line 156)
-
canvasBitBltShift : boolean
-
True if canvas supports a 'copy' bitblt onto itself when the source and destination regions overlap.
- Source code: system/Device.js (Line 162)
-
chrome : boolean
-
Set to true if running in Chrome.
- Source code: system/Device.js (Line 263)
-
chromeOS : boolean
-
Is running on chromeOS?
- Source code: system/Device.js (Line 124)
-
chromeVersion : number
-
If running in Chrome this will contain the major version number.
- Source code: system/Device.js (Line 269)
-
cocoonJS : boolean
-
Is the game running under CocoonJS?
- Source code: system/Device.js (Line 70)
-
cocoonJSApp : boolean
-
Is this game running with CocoonJS.App?
- Source code: system/Device.js (Line 76)
-
cordova : boolean
-
Is the game running under Apache Cordova?
- Source code: system/Device.js (Line 82)
-
crosswalk : boolean
-
Is the game running under the Intel Crosswalk XDK?
- Source code: system/Device.js (Line 112)
-
css3D : boolean
-
Is css3D available?
- Source code: system/Device.js (Line 198)
-
desktop : boolean
-
Is running on a desktop?
- Source code: system/Device.js (Line 52)
-
<internal> deviceReadyAt : integer
-
The time the device became ready.
- Internal:
- This member is internal (protected) and may be modified or removed in the future.
- Source code: system/Device.js (Line 37)
-
dolby : boolean
-
Can this device play EC-3 Dolby Digital Plus files?
- Source code: system/Device.js (Line 416)
-
edge : boolean
-
Set to true if running in Microsoft Edge browser.
- Source code: system/Device.js (Line 317)
-
ejecta : boolean
-
Is the game running under Ejecta?
- Source code: system/Device.js (Line 106)
-
electron : boolean
-
Is the game running under GitHub Electron?
- Source code: system/Device.js (Line 100)
-
epiphany : boolean
-
Set to true if running in Epiphany.
- Source code: system/Device.js (Line 275)
-
file : boolean
-
Is file available?
- Source code: system/Device.js (Line 174)
-
fileSystem : boolean
-
Is fileSystem available?
- Source code: system/Device.js (Line 180)
-
firefox : boolean
-
Set to true if running in Firefox.
- Source code: system/Device.js (Line 281)
-
firefoxVersion : number
-
If running in Firefox this will contain the major version number.
- Source code: system/Device.js (Line 287)
-
fullscreen : boolean
-
Does the browser support the Full Screen API?
- Source code: system/Device.js (Line 506)
-
fullscreenKeyboard : boolean
-
Does the browser support access to the Keyboard during Full Screen mode?
- Source code: system/Device.js (Line 524)
-
getUserMedia : boolean
-
Does the device support the getUserMedia API?
- Default Value
- true
- Source code: system/Device.js (Line 222)
-
h264Video : boolean
-
Can this device play h264 mp4 video files?
- Source code: system/Device.js (Line 430)
-
hlsVideo : boolean
-
Can this device play hls video files?
- Source code: system/Device.js (Line 454)
-
ie : boolean
-
Set to true if running in Internet Explorer.
- Source code: system/Device.js (Line 293)
-
ieVersion : number
-
If running in Internet Explorer this will contain the major version number. Beyond IE10 you should use Device.trident and Device.tridentVersion.
- Source code: system/Device.js (Line 299)
-
<internal> initialized : boolean
-
The time as which initialization has completed.
- Internal:
- This member is internal (protected) and may be modified or removed in the future.
- Source code: system/Device.js (Line 44)
-
iOS : boolean
-
Is running on iOS?
- Source code: system/Device.js (Line 58)
-
iOSVersion : number
-
If running in iOS this will contain the major version number.
- Source code: system/Device.js (Line 64)
-
iPad : boolean
-
Is running on iPad?
- Source code: system/Device.js (Line 474)
-
iPhone : boolean
-
Is running on iPhone?
- Source code: system/Device.js (Line 462)
-
iPhone4 : boolean
-
Is running on iPhone4?
- Source code: system/Device.js (Line 468)
-
linux : boolean
-
Is running on linux?
- Source code: system/Device.js (Line 130)
-
LITTLE_ENDIAN : boolean
-
Same value as
littleEndian
.- Source code: system/Device.js (Line 494)
-
littleEndian : boolean
-
Is the device big or little endian? (only detected if the browser supports TypedArrays)
- Source code: system/Device.js (Line 488)
-
localStorage : boolean
-
Is localStorage available?
- Source code: system/Device.js (Line 186)
-
m4a : boolean
-
Can this device play m4a files? True if this device can play m4a files.
- Source code: system/Device.js (Line 404)
-
macOS : boolean
-
Is running on macOS?
- Source code: system/Device.js (Line 136)
-
midori : boolean
-
Set to true if running in Midori.
- Source code: system/Device.js (Line 329)
-
mobileSafari : boolean
-
Set to true if running in Mobile Safari.
- Source code: system/Device.js (Line 323)
-
mp3 : boolean
-
Can this device play mp3 files?
- Source code: system/Device.js (Line 391)
-
mp4Video : boolean
-
Can this device play h264 mp4 video files?
- Source code: system/Device.js (Line 436)
-
mspointer : boolean
-
Is mspointer available?
- Source code: system/Device.js (Line 242)
-
node : boolean
-
Is the game running under Node.js?
- Source code: system/Device.js (Line 88)
-
nodeWebkit : boolean
-
Is the game running under Node-Webkit?
- Source code: system/Device.js (Line 94)
-
ogg : boolean
-
Can this device play ogg files?
- Source code: system/Device.js (Line 379)
-
oggVideo : boolean
-
Can this device play ogg video files?
- Source code: system/Device.js (Line 424)
-
opera : boolean
-
Set to true if running in Opera.
- Source code: system/Device.js (Line 335)
-
opus : boolean
-
Can this device play opus files?
- Source code: system/Device.js (Line 385)
-
pixelRatio : number
-
PixelRatio of the host device?
- Source code: system/Device.js (Line 482)
-
pointerLock : boolean
-
Is Pointer Lock available?
- Source code: system/Device.js (Line 204)
-
quirksMode : boolean
-
Is the browser running in strict mode (false) or quirks mode? (true)
- Source code: system/Device.js (Line 228)
-
requestFullscreen : string
-
If the browser supports the Full Screen API this holds the call you need to use to activate it.
- Source code: system/Device.js (Line 512)
-
safari : boolean
-
Set to true if running in Safari.
- Source code: system/Device.js (Line 341)
-
safariVersion : number
-
If running in Safari this will contain the major version number.
- Source code: system/Device.js (Line 347)
-
silk : boolean
-
Set to true if running in the Silk browser (as used on the Amazon Kindle)
- Source code: system/Device.js (Line 359)
-
support32bit : boolean
-
Does the device context support 32bit pixel manipulation using array buffer views?
- Source code: system/Device.js (Line 500)
-
touch : boolean
-
Is touch available?
- Source code: system/Device.js (Line 236)
-
trident : boolean
-
Set to true if running a Trident version of Internet Explorer (IE11+)
- Source code: system/Device.js (Line 305)
-
tridentVersion : number
-
If running in Internet Explorer 11 this will contain the major version number. See http://msdn.microsoft.com/en-us/library/ie/ms537503(v=vs.85).aspx
- Source code: system/Device.js (Line 311)
-
typedArray : boolean
-
Does the browser support TypedArrays?
- Source code: system/Device.js (Line 210)
-
vibration : boolean
-
Does the device support the Vibration API?
- Source code: system/Device.js (Line 216)
-
vp9Video : boolean
-
Can this device play vp9 video files?
- Source code: system/Device.js (Line 448)
-
wav : boolean
-
Can this device play wav files?
- Source code: system/Device.js (Line 397)
-
webApp : boolean
-
Set to true if running as a WebApp, i.e. within a WebView
- Source code: system/Device.js (Line 353)
-
webAudio : boolean
-
Is the WebAudio API available?
- Source code: system/Device.js (Line 373)
-
webGL : boolean
-
Is webGL available?
- Source code: system/Device.js (Line 168)
-
webm : boolean
-
Can this device play webm files?
- Source code: system/Device.js (Line 410)
-
webmVideo : boolean
-
Can this device play webm video files?
- Source code: system/Device.js (Line 442)
-
<internal> wheelEvent
-
- Internal:
- This member is internal (protected) and may be modified or removed in the future.
- Source code: system/Device.js (Line 249)
Properties:
Name Type Argument Description wheelType
string <nullable>
The newest type of Wheel/Scroll event supported: 'wheel', 'mousewheel', 'DOMMouseScroll'
-
windows : boolean
-
Is running on windows?
- Source code: system/Device.js (Line 142)
-
windowsPhone : boolean
-
Is running on a Windows Phone?
- Source code: system/Device.js (Line 148)
-
worker : boolean
-
Is worker available?
- Source code: system/Device.js (Line 192)
Public Methods
-
<static> whenReady(handler, context, nonPrimer)
-
Add a device-ready handler and ensure the device ready sequence is started.
Phaser.Device will not activate or initialize until at least one
whenReady
handler is added, which is normally done automatically be callingnew Phaser.Game(..)
.The handler is invoked when the device is considered "ready", which may be immediately if the device is already "ready". See deviceReadyAt.
Parameters
Name Type Argument Default Description handler
function Callback to invoke when the device is ready. It is invoked with the given context the Phaser.Device object is supplied as the first argument.
context
object <optional>
Context in which to invoke the handler
nonPrimer
boolean <optional>
false If true the device ready check will not be started.
- Source code: system/Device.js (Line 560)
-
canPlayAudio(type) → {boolean}
-
Check whether the host environment can play audio.
Parameters
Name Type Description type
string One of 'mp3, 'ogg', 'm4a', 'wav', 'webm' or 'opus'.
Returns
boolean -True if the given file type is supported by the browser, otherwise false.
- Source code: system/Device.js (Line 1250)
-
canPlayVideo(type) → {boolean}
-
Check whether the host environment can play video files.
Parameters
Name Type Description type
string One of 'mp4, 'ogg', 'webm' or 'mpeg'.
Returns
boolean -True if the given file type is supported by the browser, otherwise false.
- Source code: system/Device.js (Line 1293)
-
isAndroidStockBrowser()
-
Detect if the host is a an Android Stock browser. This is available before the device "ready" event.
Authors might want to scale down on effects and switch to the CANVAS rendering method on those devices.
- Source code: system/Device.js (Line 1359)
Example
var defaultRenderingMode = Phaser.Device.isAndroidStockBrowser() ? Phaser.CANVAS : Phaser.AUTO;
-
isConsoleOpen()
-
Check whether the console is open. Note that this only works in Firefox with Firebug and earlier versions of Chrome. It used to work in Chrome, but then they removed the ability: http://src.chromium.org/viewvc/blink?view=revision&revision=151136
- Source code: system/Device.js (Line 1324)