<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Phaser Source: core/Stage.js</title> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css"> <link type="text/css" rel="stylesheet" href="styles/site.cerulean.css"> </head> <body> <div class="container-fluid"> <div class="navbar navbar-fixed-top navbar-inverse"> <div class="navbar-inner"> <a class="brand" href="index.html">Phaser</a> <ul class="nav"> <li class="dropdown"> <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a> <ul class="dropdown-menu "> <li> <a href="Phaser.html">Phaser</a> </li> </ul> </li> <li class="dropdown"> <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a> <ul class="dropdown-menu "> <li> <a href="Phaser.Animation.html">Animation</a> </li> <li> <a href="Phaser.AnimationManager.html">AnimationManager</a> </li> <li> <a href="Phaser.AnimationParser.html">AnimationParser</a> </li> <li> <a href="Phaser.BitmapData.html">BitmapData</a> </li> <li> <a href="Phaser.BitmapFont.html">BitmapFont</a> </li> <li> <a href="Phaser.BitmapText.html">BitmapText</a> </li> <li> <a href="Phaser.Button.html">Button</a> </li> <li> <a href="Phaser.Cache.html">Cache</a> </li> <li> <a href="Phaser.Camera.html">Camera</a> </li> <li> <a href="Phaser.Canvas.html">Canvas</a> </li> <li> <a href="Phaser.Circle.html">Circle</a> </li> <li> <a href="Phaser.Color.html">Color</a> </li> <li> <a href="Phaser.Device.html">Device</a> </li> <li> <a href="Phaser.Easing.html">Easing</a> </li> <li> <a href="Phaser.Easing.Back.html">Back</a> </li> <li> <a href="Phaser.Easing.Bounce.html">Bounce</a> </li> <li> <a href="Phaser.Easing.Circular.html">Circular</a> </li> <li> <a href="Phaser.Easing.Cubic.html">Cubic</a> </li> <li> <a href="Phaser.Easing.Elastic.html">Elastic</a> </li> <li> <a href="Phaser.Easing.Exponential.html">Exponential</a> </li> <li> <a href="Phaser.Easing.Linear.html">Linear</a> </li> <li> <a href="Phaser.Easing.Quadratic.html">Quadratic</a> </li> <li> <a href="Phaser.Easing.Quartic.html">Quartic</a> </li> <li> <a href="Phaser.Easing.Quintic.html">Quintic</a> </li> <li> <a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a> </li> <li> <a href="Phaser.Ellipse.html">Ellipse</a> </li> <li> <a href="Phaser.Events.html">Events</a> </li> <li> <a href="Phaser.Filter.html">Filter</a> </li> <li> <a href="Phaser.Frame.html">Frame</a> </li> <li> <a href="Phaser.FrameData.html">FrameData</a> </li> <li> <a href="Phaser.Game.html">Game</a> </li> <li> <a href="Phaser.GameObjectCreator.html">GameObjectCreator</a> </li> <li> <a href="Phaser.GameObjectFactory.html">GameObjectFactory</a> </li> <li> <a href="Phaser.Gamepad.html">Gamepad</a> </li> <li> <a href="Phaser.GamepadButton.html">GamepadButton</a> </li> <li> <a href="Phaser.Graphics.html">Graphics</a> </li> <li> <a href="Phaser.Group.html">Group</a> </li> <li> <a href="Phaser.Image.html">Image</a> </li> <li> <a href="Phaser.Input.html">Input</a> </li> <li> <a href="Phaser.InputHandler.html">InputHandler</a> </li> <li> <a href="Phaser.Key.html">Key</a> </li> <li> <a href="Phaser.Keyboard.html">Keyboard</a> </li> <li> <a href="Phaser.Line.html">Line</a> </li> <li> <a href="Phaser.LinkedList.html">LinkedList</a> </li> <li> <a href="Phaser.Loader.html">Loader</a> </li> <li> <a href="Phaser.LoaderParser.html">LoaderParser</a> </li> <li> <a href="Phaser.Math.html">Math</a> </li> <li> <a href="Phaser.Mouse.html">Mouse</a> </li> <li> <a href="Phaser.MSPointer.html">MSPointer</a> </li> <li> <a href="Phaser.Net.html">Net</a> </li> <li> <a href="Phaser.Particles.html">Particles</a> </li> <li> <a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a> </li> <li> <a href="Phaser.Physics.html">Physics</a> </li> <li> <a href="Phaser.Physics.Arcade.html">Arcade</a> </li> <li> <a href="Phaser.Physics.Body.html">Body</a> </li> <li> <a href="Phaser.Physics.CollisionGroup.html">CollisionGroup</a> </li> <li> <a href="Phaser.Physics.ContactMaterial.html">ContactMaterial</a> </li> <li> <a href="Phaser.Physics.InversePointProxy.html">InversePointProxy</a> </li> <li> <a href="Phaser.Physics.Material.html">Material</a> </li> <li> <a href="Phaser.Physics.PointProxy.html">PointProxy</a> </li> <li> <a href="Phaser.Physics.Spring.html">Spring</a> </li> <li> <a href="Phaser.Physics.World.html">World</a> </li> <li> <a href="Phaser.Plugin.html">Plugin</a> </li> <li> <a href="Phaser.PluginManager.html">PluginManager</a> </li> <li> <a href="Phaser.Point.html">Point</a> </li> <li> <a href="Phaser.Pointer.html">Pointer</a> </li> <li> <a href="Phaser.Polygon.html">Polygon</a> </li> <li> <a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a> </li> <li> <a href="Phaser.Rectangle.html">Rectangle</a> </li> <li> <a href="Phaser.RenderTexture.html">RenderTexture</a> </li> <li> <a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a> </li> <li> <a href="Phaser.Signal.html">Signal</a> </li> <li> <a href="Phaser.SinglePad.html">SinglePad</a> </li> <li> <a href="Phaser.Sound.html">Sound</a> </li> <li> <a href="Phaser.SoundManager.html">SoundManager</a> </li> <li> <a href="Phaser.Sprite.html">Sprite</a> </li> <li> <a href="Phaser.SpriteBatch.html">SpriteBatch</a> </li> <li> <a href="Phaser.Stage.html">Stage</a> </li> <li> <a href="Phaser.StageScaleMode.html">StageScaleMode</a> </li> <li> <a href="Phaser.State.html">State</a> </li> <li> <a href="Phaser.StateManager.html">StateManager</a> </li> <li> <a href="Phaser.Text.html">Text</a> </li> <li> <a href="Phaser.Tile.html">Tile</a> </li> <li> <a href="Phaser.Tilemap.html">Tilemap</a> </li> <li> <a href="Phaser.TilemapLayer.html">TilemapLayer</a> </li> <li> <a href="Phaser.TilemapParser.html">TilemapParser</a> </li> <li> <a href="Phaser.Tileset.html">Tileset</a> </li> <li> <a href="Phaser.TileSprite.html">TileSprite</a> </li> <li> <a href="Phaser.Time.html">Time</a> </li> <li> <a href="Phaser.Timer.html">Timer</a> </li> <li> <a href="Phaser.TimerEvent.html">TimerEvent</a> </li> <li> <a href="Phaser.Touch.html">Touch</a> </li> <li> <a href="Phaser.Tween.html">Tween</a> </li> <li> <a href="Phaser.TweenManager.html">TweenManager</a> </li> <li> <a href="Phaser.Utils.html">Utils</a> </li> <li> <a href="Phaser.Utils.Debug.html">Debug</a> </li> <li> <a href="Phaser.World.html">World</a> </li> <li> <a href="SignalBinding.html">SignalBinding</a> </li> </ul> </li> <li class="dropdown"> <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a> <ul class="dropdown-menu "> <li> <a href="global.html#canUseNewCanvasBlendModes">canUseNewCanvasBlendModes</a> </li> <li> <a href="global.html#getBounds">getBounds</a> </li> <li> <a href="global.html#getNextPowerOfTwo">getNextPowerOfTwo</a> </li> <li> <a href="global.html#hex2rgb">hex2rgb</a> </li> <li> <a href="global.html#hitTest">hitTest</a> </li> <li> <a href="global.html#rgb2hex">rgb2hex</a> </li> </ul> </li> </ul> </div> </div> <div class="row-fluid"> <div class="span12"> <div id="main"> <h1 class="page-title">Source: core/Stage.js</h1> <section> <article> <pre class="sunlight-highlight-javascript linenums">/** * @author Richard Davey <rich@photonstorm.com> * @copyright 2014 Photon Storm Ltd. * @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License} */ /** * The Stage controls the canvas on which everything is displayed. It handles display within the browser, * focus handling, game resizing, scaling and the pause, boot and orientation screens. * * @class Phaser.Stage * @extends PIXI.Stage * @constructor * @param {Phaser.Game} game - Game reference to the currently running game. * @param {number} width - Width of the canvas element. * @param {number} height - Height of the canvas element. */ Phaser.Stage = function (game, width, height) { /** * @property {Phaser.Game} game - A reference to the currently running Game. */ this.game = game; /** * @property {Phaser.Point} offset - Holds the offset coordinates of the Game.canvas from the top-left of the browser window (used by Input and other classes) */ this.offset = new Phaser.Point(); PIXI.Stage.call(this, 0x000000, false); /** * @property {string} name - The name of this object. * @default */ this.name = '_stage_root'; this.interactive = false; /** * @property {boolean} disableVisibilityChange - By default if the browser tab loses focus the game will pause. You can stop that behaviour by setting this property to true. * @default */ this.disableVisibilityChange = false; /** * @property {number|false} checkOffsetInterval - The time (in ms) between which the stage should check to see if it has moved. * @default */ this.checkOffsetInterval = 2500; /** * @property {boolean} exists - If exists is true the Stage and all children are updated, otherwise it is skipped. * @default */ this.exists = true; /** * @property {string} hiddenVar - The page visibility API event name. * @private */ this._hiddenVar = 'hidden'; /** * @property {number} _nextOffsetCheck - The time to run the next offset check. * @private */ this._nextOffsetCheck = 0; /** * @property {number} _backgroundColor - Stage background color. * @private */ this._backgroundColor; if (game.config) { this.parseConfig(game.config); } else { this.game.canvas = Phaser.Canvas.create(width, height); this.game.canvas.style['-webkit-full-screen'] = 'width: 100%; height: 100%'; } }; Phaser.Stage.prototype = Object.create(PIXI.Stage.prototype); Phaser.Stage.prototype.constructor = Phaser.Stage; /** * This is called automatically after the plugins preUpdate and before the State.update. * Most objects have preUpdate methods and it's where initial movement and positioning is done. * * @method Phaser.Stage#preUpdate */ Phaser.Stage.prototype.preUpdate = function () { this.currentRenderOrderID = 0; var i = this.children.length; while (i--) { this.children[i].preUpdate(); } } /** * This is called automatically after the State.update, but before particles or plugins update. * * @method Phaser.Stage#update */ Phaser.Stage.prototype.update = function () { var i = this.children.length; while (i--) { this.children[i].update(); } } /** * This is called automatically before the renderer runs and after the plugins have updated. * In postUpdate this is where all the final physics calculatations and object positioning happens. * The objects are processed in the order of the display list. * The only exception to this is if the camera is following an object, in which case that is updated first. * * @method Phaser.Stage#postUpdate */ Phaser.Stage.prototype.postUpdate = function () { if (this.game.world.camera.target) { this.game.world.camera.target.postUpdate(); this.game.world.camera.update(); var i = this.children.length; while (i--) { if (this.children[i] !== this.game.world.camera.target) { this.children[i].postUpdate(); } } } else { this.game.world.camera.update(); var i = this.children.length; while (i--) { this.children[i].postUpdate(); } } } /** * Parses a Game configuration object. * * @method Phaser.Stage#parseConfig * @protected */ Phaser.Stage.prototype.parseConfig = function (config) { if (config['canvasID']) { this.game.canvas = Phaser.Canvas.create(this.game.width, this.game.height, config['canvasID']); } else { this.game.canvas = Phaser.Canvas.create(this.game.width, this.game.height); } if (config['canvasStyle']) { this.game.canvas.stlye = config['canvasStyle']; } else { this.game.canvas.style['-webkit-full-screen'] = 'width: 100%; height: 100%'; } if (config['checkOffsetInterval']) { this.checkOffsetInterval = config['checkOffsetInterval']; } if (config['disableVisibilityChange']) { this.disableVisibilityChange = config['disableVisibilityChange']; } if (config['fullScreenScaleMode']) { this.fullScreenScaleMode = config['fullScreenScaleMode']; } if (config['scaleMode']) { this.scaleMode = config['scaleMode']; } if (config['backgroundColor']) { this.backgroundColor = config['backgroundColor']; } } /** * Initialises the stage and adds the event listeners. * @method Phaser.Stage#boot * @private */ Phaser.Stage.prototype.boot = function () { Phaser.Canvas.getOffset(this.game.canvas, this.offset); this.bounds = new Phaser.Rectangle(this.offset.x, this.offset.y, this.game.width, this.game.height); var _this = this; this._onChange = function (event) { return _this.visibilityChange(event); } Phaser.Canvas.setUserSelect(this.game.canvas, 'none'); Phaser.Canvas.setTouchAction(this.game.canvas, 'none'); this.checkVisibility(); } /** * Starts a page visibility event listener running, or window.blur/focus if not supported by the browser. * @method Phaser.Stage#checkVisibility */ Phaser.Stage.prototype.checkVisibility = function () { var supportsVisibilityApi = false; var prefixes = [ "", "moz", "ms", "webkit" ]; while (prefixes.length) { prefix = prefixes.pop(); this._hiddenVar = prefix ? prefix + "Hidden" : "hidden"; if (this._hiddenVar in document) { supportsVisibilityApi = true; break; } } // Does browser support it? If not (like in IE9 or old Android) we need to fall back to blur/focus if (supportsVisibilityApi) { document.addEventListener(this._hiddenVar, this._onChange, false); document.addEventListener('pagehide', this._onChange, false); document.addEventListener('pageshow', this._onChange, false); } window.onblur = this._onChange; window.onfocus = this._onChange; } /** * Runs Stage processes that need periodic updates, such as the offset checks. * @method Phaser.Stage#update */ Phaser.Stage.prototype.update = function () { if (this.checkOffsetInterval !== false) { if (this.game.time.now > this._nextOffsetCheck) { Phaser.Canvas.getOffset(this.game.canvas, this.offset); this._nextOffsetCheck = this.game.time.now + this.checkOffsetInterval; } } } /** * This method is called when the document visibility is changed. * @method Phaser.Stage#visibilityChange * @param {Event} event - Its type will be used to decide whether the game should be paused or not. */ Phaser.Stage.prototype.visibilityChange = function (event) { if (this.disableVisibilityChange) { return; } if (this.game.paused === false && (event.type === 'pagehide' || event.type === 'blur' || document[this._hiddenVar] === true)) { this.game.paused = true; } else { this.game.paused = false; } } /** * Sets the background color for the stage. * * @name Phaser.Stage#setBackgroundColor * @param {number} backgroundColor - The color of the background, easiest way to pass this in is in hex format like: 0xFFFFFF for white. */ Phaser.Stage.prototype.setBackgroundColor = function(backgroundColor) { this._backgroundColor = backgroundColor || 0x000000; this.backgroundColorSplit = PIXI.hex2rgb(this.backgroundColor); var hex = this._backgroundColor.toString(16); hex = '000000'.substr(0, 6 - hex.length) + hex; this.backgroundColorString = '#' + hex; } /** * @name Phaser.Stage#backgroundColor * @property {number|string} backgroundColor - Gets and sets the background color of the stage. The color can be given as a number: 0xff0000 or a hex string: '#ff0000' */ Object.defineProperty(Phaser.Stage.prototype, "backgroundColor", { get: function () { return this._backgroundColor; }, set: function (color) { this._backgroundColor = color; if (this.game.transparent === false) { if (typeof color === 'string') { color = Phaser.Color.hexToRGB(color); } this.setBackgroundColor(color); } } }); </pre> </article> </section> </div> <div class="clearfix"></div> <footer> <span class="copyright"> Phaser Copyright © 2012-2014 Photon Storm Ltd. </span> <br /> <span class="jsdoc-message"> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a> on Mon Feb 24 2014 12:11:34 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. </span> </footer> </div> <br clear="both"> </div> </div> <script src="scripts/sunlight.js"></script> <script src="scripts/sunlight.javascript.js"></script> <script src="scripts/sunlight-plugin.doclinks.js"></script> <script src="scripts/sunlight-plugin.linenumbers.js"></script> <script src="scripts/sunlight-plugin.menu.js"></script> <script src="scripts/jquery.min.js"></script> <script src="scripts/jquery.scrollTo.js"></script> <script src="scripts/jquery.localScroll.js"></script> <script src="scripts/bootstrap-dropdown.js"></script> <script src="scripts/toc.js"></script> <script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script> <script> $( function () { $( "#toc" ).toc( { selectors : "h1,h2,h3,h4", showAndHide : false, scrollTo : 60 } ); $( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" ); $( "#main span[id^='toc']" ).addClass( "toc-shim" ); } ); </script> </body> </html>