phaser/resources/docgen/output/Phaser.Device.json

{"class":{"name":"Phaser.Device","extends":"","static":false,"constructor":true,"parameters":[],"help":"Detects device support capabilities. Using some elements from System.js by MrDoob and Modernizr"},"consts":[],"methods":{"public":[{"name":"canPlayAudio","static":false,"returns":{"types":["boolean"],"help":"True if the given file type is supported by the browser, otherwise false."},"help":"Check whether the host environment can play audio.","line":882,"public":true,"protected":false,"private":false,"parameters":[{"name":"type","type":["string"],"help":"One of 'mp3, 'ogg', 'm4a', 'wav', 'webm' or 'opus'.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkFullScreenSupport","static":false,"returns":null,"help":"Checks for support of the Full Screen API.","line":526,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"isConsoleOpen","static":false,"returns":{"types":["boolean"],"help":"True if the browser dev console is open."},"help":"Check whether the console is open.\\nNote that this only works in Firefox with Firebug and earlier versions of Chrome.\\nIt used to work in Chrome, but then they removed the ability: http:\/\/src.chromium.org\/viewvc\/blink?view=revision&revision=151136","line":921,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"_checkAudio","static":false,"returns":null,"help":"Check audio support.","line":701,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_checkBrowser","static":false,"returns":null,"help":"Check what browser is game running in.","line":586,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_checkCSS3D","static":false,"returns":null,"help":"Check whether the host environment support 3D CSS.","line":847,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_checkDevice","static":false,"returns":null,"help":"Check PixelRatio, iOS device, Vibration API, ArrayBuffers and endianess.","line":748,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_checkFeatures","static":false,"returns":null,"help":"Check HTML5 features of the host environment.","line":478,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_checkIsLittleEndian","static":false,"returns":null,"help":"Check Little or Big Endian system.","line":787,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_checkIsUint8ClampedImageData","static":false,"returns":null,"help":"Test to see if ImageData uses CanvasPixelArray or Uint8ClampedArray.","line":821,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"_checkOS","static":false,"returns":null,"help":"Check which OS is game running on.","line":416,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"android","type":["boolean"],"help":"","inlineHelp":"Is running on android?","line":80,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"arora","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Arora.","line":204,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"audioData","type":["boolean"],"help":"","inlineHelp":"Are Audio tags available?","line":290,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"cancelFullscreen","type":["string"],"help":"","inlineHelp":"If the browser supports the Full Screen API this holds the call you need to use to cancel it.","line":389,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"canvas","type":["boolean"],"help":"","inlineHelp":"Is canvas available?","line":118,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"chrome","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Chrome.","line":210,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"chromeOS","type":["boolean"],"help":"","inlineHelp":"Is running on chromeOS?","line":86,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"cocoonJS","type":["boolean"],"help":"","inlineHelp":"Is the game running under CocoonJS?","line":38,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"cocoonJSApp","type":["boolean"],"help":"","inlineHelp":"Is this game running with CocoonJS.App?","line":44,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"cordova","type":["boolean"],"help":"","inlineHelp":"Is the game running under Apache Cordova?","line":50,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"crosswalk","type":["boolean"],"help":"","inlineHelp":"Is the game running under the Intel Crosswalk XDK?","line":74,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"css3D","type":["boolean"],"help":"","inlineHelp":"Is css3D available?","line":166,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"desktop","type":["boolean"],"help":"","inlineHelp":"Is running desktop?","line":26,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"ejecta","type":["boolean"],"help":"","inlineHelp":"Is the game running under Ejecta?","line":68,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"epiphany","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Epiphany.","line":216,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"file","type":["boolean"],"help":"","inlineHelp":"Is file available?","line":124,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"fileSystem","type":["boolean"],"help":"","inlineHelp":"Is fileSystem available?","line":130,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"firefox","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Firefox.","line":222,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"fullscreen","type":["boolean"],"help":"","inlineHelp":"Does the browser support the Full Screen API?","line":377,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"fullscreenKeyboard","type":["boolean"],"help":"","inlineHelp":"Does the browser support access to the Keyboard during Full Screen mode?","line":395,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":18,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"getUserMedia","type":["boolean"],"help":"","inlineHelp":"Does the device support the getUserMedia API?","line":190,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"iOS","type":["boolean"],"help":"","inlineHelp":"Is running on iOS?","line":32,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"iPad","type":["boolean"],"help":"","inlineHelp":"Is running on iPad?","line":353,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"iPhone","type":["boolean"],"help":"","inlineHelp":"Is running on iPhone?","line":341,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"iPhone4","type":["boolean"],"help":"","inlineHelp":"Is running on iPhone4?","line":347,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"ie","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Internet Explorer.","line":228,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"ieVersion","type":["number"],"help":"","inlineHelp":"If running in Internet Explorer this will contain the major version number. Beyond IE10 you should use Device.trident and Device.tridentVersion.","line":234,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"linux","type":["boolean"],"help":"","inlineHelp":"Is running on linux?","line":92,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"littleEndian","type":["boolean"],"help":"","inlineHelp":"Is the device big or little endian? (only detected if the browser supports TypedArrays)","line":365,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"localStorage","type":["boolean"],"help":"","inlineHelp":"Is localStorage available?","line":136,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"m4a","type":["boolean"],"help":"Can this device play m4a files?","inlineHelp":"True if this device can play m4a files.","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"macOS","type":["boolean"],"help":"","inlineHelp":"Is running on macOS?","line":98,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"midori","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Midori.","line":258,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mobileSafari","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Mobile Safari.","line":252,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mp3","type":["boolean"],"help":"","inlineHelp":"Can this device play mp3 files?","line":314,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mspointer","type":["boolean"],"help":"","inlineHelp":"Is mspointer available?","line":160,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"node","type":["boolean"],"help":"","inlineHelp":"Is the game running under Node.js?","line":56,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"nodeWebkit","type":["boolean"],"help":"","inlineHelp":"Is the game running under Node-Webkit?","line":62,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"ogg","type":["boolean"],"help":"","inlineHelp":"Can this device play ogg files?","line":302,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"opera","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Opera.","line":264,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"opus","type":["boolean"],"help":"","inlineHelp":"Can this device play opus files?","line":308,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"pixelRatio","type":["number"],"help":"","inlineHelp":"PixelRatio of the host device?","line":359,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"pointerLock","type":["boolean"],"help":"","inlineHelp":"Is Pointer Lock available?","line":172,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"quirksMode","type":["boolean"],"help":"","inlineHelp":"Is the browser running in strict mode (false) or quirks mode? (true)","line":196,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"requestFullscreen","type":["string"],"help":"","inlineHelp":"If the browser supports the Full Screen API this holds the call you need to use to activate it.","line":383,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"safari","type":["boolean"],"help":"","inlineHelp":"Set to true if running in Safari.","line":270,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"silk","type":["boolean"],"help":"","inlineHelp":"Set to true if running in the Silk browser (as used on the Amazon Kindle)","line":282,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"support32bit","type":["boolean"],"help":"","inlineHelp":"Does the device context support 32bit pixel manipulation using array buffer views?","line":371,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"touch","type":["boolean"],"help":"","inlineHelp":"Is touch available?","line":154,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"trident","type":["boolean"],"help":"","inlineHelp":"Set to true if running a Trident version of Internet Explorer (IE11+)","line":240,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"tridentVersion","type":["number"],"help":"","inlineHelp":"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","line":246,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"typedArray","type":["boolean"],"help":"","inlineHelp":"Does the browser support TypedArrays?","line":178,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"vibration","type":["boolean"],"help":"","inlineHelp":"Does the device support the Vibration API?","line":184,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"wav","type":["boolean"],"help":"","inlineHelp":"Can this device play wav files?","line":320,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"webApp","type":["boolean"],"help":"","inlineHelp":"Set to true if running as a WebApp, i.e. within a WebView","line":276,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"webAudio","type":["boolean"],"help":"","inlineHelp":"Is the WebAudio API available?","line":296,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"webGL","type":["boolean"],"help":"","inlineHelp":"Is webGL available?","line":142,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"webm","type":["boolean"],"help":"","inlineHelp":"Can this device play webm files?","line":333,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"windows","type":["boolean"],"help":"","inlineHelp":"Is running on windows?","line":104,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"windowsPhone","type":["boolean"],"help":"","inlineHelp":"Is running on a Windows Phone?","line":110,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"worker","type":["boolean"],"help":"","inlineHelp":"Is worker available?","line":148,"default":"false","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}}