phaser/docs/src_core_ScaleManager.js.html

3534 lines
110 KiB
HTML
Raw Normal View History

2013-10-03 00:21:08 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
2015-03-23 23:46:30 +00:00
<title>Phaser Source: src/core/ScaleManager.js</title>
2013-10-03 00:21:08 +00:00
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
2014-11-15 20:01:46 +00:00
<link type="text/css" rel="stylesheet" href="styles/default.css">
2013-10-03 00:21:08 +00:00
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
2014-11-25 00:23:44 +00:00
2013-10-03 00:21:08 +00:00
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
2014-11-25 00:23:44 +00:00
<div style="position: absolute; width: 143px; height: 31px; right: 10px; top: 10px; z-index: 1050"><a href="http://phaser.io"><img src="img/phaser.png" border="0" /></a></div>
2013-10-03 00:21:08 +00:00
<div class="navbar-inner">
2014-11-25 00:23:44 +00:00
<a class="brand" href="index.html">Phaser API</a>
2013-10-03 00:21:08 +00:00
<ul class="nav">
2014-11-25 00:23:44 +00:00
2013-10-03 00:21:08 +00:00
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
2013-10-03 00:21:08 +00:00
class="caret"></b></a>
<ul class="dropdown-menu ">
2014-04-10 22:13:43 +00:00
<li class="class-depth-0">
<a href="Phaser.html">Phaser</a>
2013-10-03 00:21:08 +00:00
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-0">
<a href="PIXI.html">PIXI</a>
</li>
2013-10-03 00:21:08 +00:00
</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 ">
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="Matrix.html">Matrix</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Animation.html">Animation</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.AnimationManager.html">AnimationManager</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-29 14:39:02 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.ArraySet.html">ArraySet</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayUtils.html">ArrayUtils</a>
</li>
2014-10-09 15:12:53 +00:00
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Button.html">Button</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
2013-10-03 00:21:08 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-2">
<a href="Phaser.Component.Angle.html">Angle</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Animation.html">Animation</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.AutoCull.html">AutoCull</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Bounds.html">Bounds</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.BringToTop.html">BringToTop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Core.html">Core</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Crop.html">Crop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Delta.html">Delta</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Destroy.html">Destroy</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.FixedToCamera.html">FixedToCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Health.html">Health</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InCamera.html">InCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InputEnabled.html">InputEnabled</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InWorld.html">InWorld</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LifeSpan.html">LifeSpan</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LoadTexture.html">LoadTexture</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Overlap.html">Overlap</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.PhysicsBody.html">PhysicsBody</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Reset.html">Reset</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.ScaleMinMax.html">ScaleMinMax</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Smoothed.html">Smoothed</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Device.html">Device</a>
2013-10-03 00:21:08 +00:00
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.DOM.html">DOM</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Easing.html">Easing</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Back.html">Back</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Events.html">Events</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Filter.html">Filter</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-1">
<a href="Phaser.FlexGrid.html">FlexGrid</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexLayer.html">FlexLayer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Game.html">Game</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.GamepadButton.html">GamepadButton</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Graphics.html">Graphics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Group.html">Group</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Input.html">Input</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Key.html">Key</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Line.html">Line</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Loader.html">Loader</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.LoaderParser.html">LoaderParser</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Math.html">Math</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Mouse.html">Mouse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Net.html">Net</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Particles.html">Particles</a>
</li>
2014-10-09 15:12:53 +00:00
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.html">Physics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.html#TilemapCollision">TilemapCollision</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Plugin.html">Plugin</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Point.html">Point</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Pointer.html">Pointer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Sound.html">Sound</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Sprite.html">Sprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Stage.html">Stage</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.State.html">State</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.StateManager.html">StateManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Text.html">Text</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tile.html">Tile</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tileset.html">Tileset</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Time.html">Time</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Timer.html">Timer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Touch.html">Touch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenData.html">TweenData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.World.html">World</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="PIXI.AbstractFilter.html">AbstractFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BaseTexture.html">BaseTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasBuffer.html">CanvasBuffer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasGraphics.html">CanvasGraphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasMaskManager.html">CanvasMaskManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasRenderer.html">CanvasRenderer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasTinter.html">CanvasTinter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObject.html">DisplayObject</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObjectContainer.html">DisplayObjectContainer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Event.html">Event</a>
</li>
<li class="class-depth-1">
<a href="PIXI.EventTarget.html">EventTarget</a>
</li>
<li class="class-depth-1">
<a href="PIXI.FilterTexture.html">FilterTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.GraphicsData.html">GraphicsData</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PIXI.html">PIXI</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiFastShader.html">PixiFastShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiShader.html">PixiShader</a>
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.PolyK.html">PolyK</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.PrimitiveShader.html">PrimitiveShader</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.RenderTexture.html">RenderTexture</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Rope.html">Rope</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Sprite.html">Sprite</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.SpriteBatch.html">SpriteBatch</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Stage.html">Stage</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Strip.html">Strip</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.StripShader.html">StripShader</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Text.html">Text</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Texture.html">Texture</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.TilingSprite.html">TilingSprite</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.VideoTexture.html">VideoTexture</a>
2014-11-15 20:01:46 +00:00
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a>
2014-11-25 00:23:44 +00:00
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLRenderer.html">WebGLRenderer</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="RoundedRectangle.html">RoundedRectangle</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
</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 class="class-depth-0">
<a href="global.html#append">append</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#apply">apply</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#applyInverse">applyInverse</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#blendModes">blendModes</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#clone">clone</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#contains">contains</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#fromArray">fromArray</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#identity">identity</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#rotate">rotate</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#scale">scale</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#scaleModes">scaleModes</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#sort">sort</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#toArray">toArray</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#translate">translate</a>
2014-11-15 20:01:46 +00:00
</li>
2013-10-03 00:21:08 +00:00
</ul>
</li>
2014-11-25 00:23:44 +00:00
2014-11-15 20:01:46 +00:00
<li class="dropdown">
2014-11-25 00:23:44 +00:00
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Core<b class="caret"></b></a>
<ul class="dropdown-menu ">
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="Phaser.Game.html">Game</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Group.html">Group</a></li>
<li class="class-depth-1"><a href="Phaser.World.html">World</a></li>
<li class="class-depth-1"><a href="Phaser.Loader.html">Loader</a></li>
<li class="class-depth-1"><a href="Phaser.Time.html">Time</a></li>
<li class="class-depth-1"><a href="Phaser.Camera.html">Camera</a></li>
<li class="class-depth-1"><a href="Phaser.StateManager.html">State Manager</a></li>
<li class="class-depth-1"><a href="Phaser.TweenManager.html">Tween Manager</a></li>
<li class="class-depth-1"><a href="Phaser.SoundManager.html">Sound Manager</a></li>
2015-01-06 06:57:25 +00:00
<li class="class-depth-1"><a href="Phaser.Input.html">Input Manager</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.ScaleManager.html">Scale Manager</a></li>
</ul>
</li>
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Game Objects<b class="caret"></b></a>
2014-11-15 20:01:46 +00:00
<ul class="dropdown-menu ">
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.GameObjectFactory.html">Factory (game.add)</a></li>
<li class="class-depth-1"><a href="Phaser.GameObjectCreator.html">Creator (game.make)</a></li>
<li class="class-depth-1"><a href="Phaser.Sprite.html">Sprite</a></li>
<li class="class-depth-1"><a href="Phaser.Image.html">Image</a></li>
<li class="class-depth-1"><a href="Phaser.Sound.html">Sound</a></li>
2015-01-06 06:57:25 +00:00
<li class="class-depth-1"><a href="Phaser.Particles.Arcade.Emitter.html">Particle Emitter</a></li>
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="Phaser.Particle.html">Particle</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Text.html">Text</a></li>
<li class="class-depth-1"><a href="Phaser.Tween.html">Tween</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapText.html">BitmapText</a></li>
<li class="class-depth-1"><a href="Phaser.Tilemap.html">Tilemap</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapData.html">BitmapData</a></li>
<li class="class-depth-1"><a href="Phaser.RetroFont.html">RetroFont</a></li>
<li class="class-depth-1"><a href="Phaser.Button.html">Button</a></li>
<li class="class-depth-1"><a href="Phaser.Animation.html">Animation</a></li>
<li class="class-depth-1"><a href="Phaser.Graphics.html">Graphics</a></li>
<li class="class-depth-1"><a href="Phaser.RenderTexture.html">RenderTexture</a></li>
<li class="class-depth-1"><a href="Phaser.TileSprite.html">TileSprite</a></li>
</ul>
</li>
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Geometry<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Circle.html">Circle</a></li>
<li class="class-depth-1"><a href="Phaser.Rectangle.html">Rectangle</a></li>
<li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li>
<li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li>
<li class="class-depth-1"><a href="Phaser.Ellipse.html">Ellipse</a></li>
<li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li>
2014-11-15 20:01:46 +00:00
</ul>
</li>
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Physics<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Physics.Arcade.html">Arcade Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Arcade.Body.html">Body</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.P2.html">P2 Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Body.html">Body</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Spring.html">Spring</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.Ninja.html">Ninja Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Body.html">Body</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Input<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.InputHandler.html">Input Handler</a></li>
<li class="class-depth-1"><a href="Phaser.Pointer.html">Pointer</a></li>
<li class="class-depth-1"><a href="Phaser.Mouse.html">Mouse</a></li>
<li class="class-depth-1"><a href="Phaser.Keyboard.html">Keyboard</a></li>
<li class="class-depth-1"><a href="Phaser.Key.html">Key</a></li>
<li class="class-depth-1"><a href="Phaser.Gamepad.html">Gamepad</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Community<b class="caret"></b></a>
<ul class="dropdown-menu ">
2015-03-26 02:55:18 +00:00
<li class="class-depth-1"><a href="http://phaser.io">Phaser Web Site</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li>
2015-03-26 02:55:18 +00:00
<li class="class-depth-1"><a href="http://phaser.io/examples">Phaser Examples</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser-plugins">Phaser Plugins</a></li>
<li class="class-depth-1"><a href="http://www.html5gamedevs.com/forum/14-phaser/">Forum</a></li>
<li class="class-depth-1"><a href="http://stackoverflow.com/questions/tagged/phaser-framework">Stack Overflow</a></li>
2015-03-26 02:55:18 +00:00
<li class="class-depth-1"><a href="http://phaser.io/learn">Weekly Coding Tips</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="https://confirmsubscription.com/h/r/369DE48E3E86AF1E">Newsletter</a></li>
2015-03-26 02:55:18 +00:00
<li class="class-depth-1"><a href="http://phaser.io/community/twitter">Twitter</a></li>
<li class="class-depth-1"><a href="http://phaser.io/community/irc">IRC</a></li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-1"><a href="https://www.gittip.com/photonstorm/">Donate to the project</a></li>
<li class="class-depth-1"><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a></li>
2014-11-25 00:23:44 +00:00
</ul>
</li>
2014-11-15 20:01:46 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
2013-10-03 00:21:08 +00:00
<div class="span12">
<div id="main">
2015-03-23 23:46:30 +00:00
<h1 class="page-title">Source: src/core/ScaleManager.js</h1>
2013-10-03 00:21:08 +00:00
<section>
<article>
<pre class="sunlight-highlight-javascript linenums">/**
* @author Richard Davey &lt;rich@photonstorm.com>
2015-03-23 23:46:30 +00:00
* @copyright 2015 Photon Storm Ltd.
2013-10-03 00:21:08 +00:00
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
2014-11-25 00:23:44 +00:00
* @classdesc
* The ScaleManager object handles the the scaling, resizing, and alignment of the
* Game size and the game Display canvas.
2014-11-15 20:01:46 +00:00
*
2014-11-25 00:23:44 +00:00
* The Game size is the logical size of the game; the Display canvas has size as an HTML element.
*
* The calculations of these are heavily influenced by the bounding Parent size which is the computed
2015-03-23 23:46:30 +00:00
* dimensions of the Display canvas's Parent container/element - the _effective CSS rules of the
2014-11-25 00:23:44 +00:00
* canvas's Parent element play an important role_ in the operation of the ScaleManager.
*
2015-01-06 06:57:25 +00:00
* The Display canvas - or Game size, depending {@link #scaleMode} - is updated to best utilize the Parent size.
* When in Fullscreen mode or with {@link #parentIsWindow} the Parent size is that of the visual viewport (see {@link Phaser.ScaleManager#getParentBounds getParentBounds}).
2014-11-25 00:23:44 +00:00
*
* Parent and Display canvas containment guidelines:
*
* - Style the Parent element (of the game canvas) to control the Parent size and
* thus the Display canvas's size and layout.
*
* - The Parent element's CSS styles should _effectively_ apply maximum (and minimum) bounding behavior.
*
* - The Parent element should _not_ apply a padding as this is not accounted for.
* If a padding is required apply it to the Parent's parent or apply a margin to the Parent.
2015-01-06 06:57:25 +00:00
* If you need to add a border, margin or any other CSS around your game container, then use a parent element and
* apply the CSS to this instead, otherwise you'll be constantly resizing the shape of the game container.
2014-11-25 00:23:44 +00:00
*
2015-03-23 23:46:30 +00:00
* - The Display canvas layout CSS styles (i.e. margins, size) should not be altered/specified as
2014-11-25 00:23:44 +00:00
* they may be updated by the ScaleManager.
*
* @description
* Create a new ScaleManager object - this is done automatically by {@link Phaser.Game}
*
* The `width` and `height` constructor parameters can either be a number which represents pixels or a string that represents a percentage: e.g. `800` (for 800 pixels) or `"80%"` for 80%.
*
* @class
2013-10-03 00:21:08 +00:00
* @param {Phaser.Game} game - A reference to the currently running game.
2014-11-15 20:01:46 +00:00
* @param {number|string} width - The width of the game. See above.
* @param {number|string} height - The height of the game. See above.
2013-10-03 00:21:08 +00:00
*/
Phaser.ScaleManager = function (game, width, height) {
2013-10-03 00:21:08 +00:00
/**
2014-11-15 20:01:46 +00:00
* A reference to the currently running game.
* @property {Phaser.Game} game
* @protected
* @readonly
2013-10-03 00:21:08 +00:00
*/
this.game = game;
2013-10-03 00:21:08 +00:00
2014-11-25 00:23:44 +00:00
/**
* Provides access to some cross-device DOM functions.
* @property {Phaser.DOM} dom
* @protected
* @readonly
*/
this.dom = Phaser.DOM;
2013-10-03 00:21:08 +00:00
/**
2014-11-15 20:01:46 +00:00
* _EXPERIMENTAL:_ A responsive grid on which you can align game objects.
* @property {Phaser.FlexGrid} grid
* @public
2013-10-03 00:21:08 +00:00
*/
2014-09-09 14:36:56 +00:00
this.grid = null;
2013-10-03 00:21:08 +00:00
/**
2014-11-25 00:23:44 +00:00
* Target width (in pixels) of the Display canvas.
2014-11-15 20:01:46 +00:00
* @property {number} width
* @readonly
*/
2014-09-09 14:36:56 +00:00
this.width = 0;
/**
2014-11-25 00:23:44 +00:00
* Target height (in pixels) of the Display canvas.
2014-11-15 20:01:46 +00:00
* @property {number} height
* @readonly
2014-09-09 14:36:56 +00:00
*/
this.height = 0;
/**
2014-11-15 20:01:46 +00:00
* Minimum width the canvas should be scaled to (in pixels).
2015-01-06 06:57:25 +00:00
* Change with {@link #setMinMax}.
* @property {?number} minWidth
2014-11-15 20:01:46 +00:00
* @readonly
2014-11-25 00:23:44 +00:00
* @protected
2013-10-03 00:21:08 +00:00
*/
this.minWidth = null;
2013-10-03 00:21:08 +00:00
/**
2014-11-15 20:01:46 +00:00
* Maximum width the canvas should be scaled to (in pixels).
* If null it will scale to whatever width the browser can handle.
2015-01-06 06:57:25 +00:00
* Change with {@link #setMinMax}.
* @property {?number} maxWidth
2014-11-15 20:01:46 +00:00
* @readonly
2014-11-25 00:23:44 +00:00
* @protected
2013-10-03 00:21:08 +00:00
*/
this.maxWidth = null;
2013-10-03 00:21:08 +00:00
/**
2014-11-15 20:01:46 +00:00
* Minimum height the canvas should be scaled to (in pixels).
2015-01-06 06:57:25 +00:00
* Change with {@link #setMinMax}.
* @property {?number} minHeight
2014-11-15 20:01:46 +00:00
* @readonly
2014-11-25 00:23:44 +00:00
* @protected
2013-10-03 00:21:08 +00:00
*/
this.minHeight = null;
2013-10-03 00:21:08 +00:00
/**
2014-11-15 20:01:46 +00:00
* Maximum height the canvas should be scaled to (in pixels).
* If null it will scale to whatever height the browser can handle.
2015-01-06 06:57:25 +00:00
* Change with {@link #setMinMax}.
* @property {?number} maxHeight
2014-11-15 20:01:46 +00:00
* @readonly
2014-11-25 00:23:44 +00:00
* @protected
2013-10-03 00:21:08 +00:00
*/
this.maxHeight = null;
2013-10-03 00:21:08 +00:00
/**
2014-11-25 00:23:44 +00:00
* The offset coordinates of the Display canvas from the top-left of the browser window.
2014-11-15 20:01:46 +00:00
* The is used internally by Phaser.Pointer (for Input) and possibly other types.
* @property {Phaser.Point} offset
* @readonly
* @protected
2014-09-09 14:36:56 +00:00
*/
this.offset = new Phaser.Point();
/**
2014-11-15 20:01:46 +00:00
* If true, the game should only run in a landscape orientation.
2015-01-06 06:57:25 +00:00
* Change with {@link #forceOrientation}.
2014-11-15 20:01:46 +00:00
* @property {boolean} forceLandscape
* @readonly
2013-10-03 00:21:08 +00:00
* @default
2014-11-15 20:01:46 +00:00
* @protected
2013-10-03 00:21:08 +00:00
*/
this.forceLandscape = false;
2013-10-03 00:21:08 +00:00
/**
2014-11-15 20:01:46 +00:00
* If true, the game should only run in a portrait
2015-01-06 06:57:25 +00:00
* Change with {@link #forceOrientation}.
2014-11-15 20:01:46 +00:00
* @property {boolean} forcePortrait
* @readonly
2013-10-03 00:21:08 +00:00
* @default
2014-11-15 20:01:46 +00:00
* @protected
2013-10-03 00:21:08 +00:00
*/
2013-11-28 15:57:09 +00:00
this.forcePortrait = false;
2013-10-03 00:21:08 +00:00
/**
2015-01-06 06:57:25 +00:00
* True if {@link #forceLandscape} or {@link #forcePortrait} are set and do not agree with the browser orientation.
2014-11-25 00:23:44 +00:00
*
* This value is not updated immediately.
*
2014-11-15 20:01:46 +00:00
* @property {boolean} incorrectOrientation
* @readonly
* @protected
2013-10-03 00:21:08 +00:00
*/
this.incorrectOrientation = false;
2013-10-03 00:21:08 +00:00
/**
2015-01-06 06:57:25 +00:00
* See {@link #pageAlignHorizontally}.
2014-11-15 20:01:46 +00:00
* @property {boolean} _pageAlignHorizontally
* @private
2013-10-03 00:21:08 +00:00
*/
2014-11-15 20:01:46 +00:00
this._pageAlignHorizontally = false;
2013-10-03 00:21:08 +00:00
/**
2015-01-06 06:57:25 +00:00
* See {@link #pageAlignVertically}.
2014-11-15 20:01:46 +00:00
* @property {boolean} _pageAlignVertically
* @private
2013-11-01 18:16:52 +00:00
*/
2014-11-15 20:01:46 +00:00
this._pageAlignVertically = false;
2013-11-01 18:16:52 +00:00
2013-10-03 00:21:08 +00:00
/**
2014-11-15 20:01:46 +00:00
* The maximum number of times a canvas will be resized (in a row) in order to fill the browser.
2014-11-25 00:23:44 +00:00
* @property {number} maxIterations
2014-11-15 20:01:46 +00:00
* @protected
2014-11-25 00:23:44 +00:00
* @see {@link Phaser.ScaleManger#refresh refresh}
* @deprecated 2.2.0 - This is not used anymore as reflow iterations are "automatic".
2013-10-03 00:21:08 +00:00
*/
this.maxIterations = 5;
2014-11-25 00:23:44 +00:00
/**
* This signal is dispatched when the orientation changes _or_ the validity of the current orientation changes.
*
* The signal is supplied with the following arguments:
* - `scale` - the ScaleManager object
* - `prevOrientation`, a string - The previous orientation as per {@link Phaser.ScaleManager#screenOrientation screenOrientation}.
* - `wasIncorrect`, a boolean - True if the previous orientation was last determined to be incorrect.
*
* Access the current orientation and validity with `scale.screenOrientation` and `scale.incorrectOrientation`.
* Thus the following tests can be done:
*
* // The orientation itself changed:
* scale.screenOrientation !== prevOrientation
* // The orientation just became incorrect:
2015-03-23 23:46:30 +00:00
* scale.incorrectOrientation &amp;&amp; !wasIncorrect
2014-11-25 00:23:44 +00:00
*
2015-01-06 06:57:25 +00:00
* It is possible that this signal is triggered after {@link #forceOrientation} so the orientation
2014-11-25 00:23:44 +00:00
* correctness changes even if the orientation itself does not change.
*
* This is signaled from `preUpdate` (or `pauseUpdate`) _even when_ the game is paused.
*
* @property {Phaser.Signal} onOrientationChange
* @public
*/
this.onOrientationChange = new Phaser.Signal();
2013-10-03 00:21:08 +00:00
/**
2014-11-15 20:01:46 +00:00
* This signal is dispatched when the browser enters landscape orientation, having been in portrait.
*
* This is signaled from `preUpdate` (or `pauseUpdate`) _even when_ the game is paused.
*
* @property {Phaser.Signal} enterLandscape
* @public
2014-11-25 00:23:44 +00:00
* @deprecated 2.2.0 - Use {@link Phaser.ScaleManager#onOrientationChange onOrientationChange}
2013-10-03 00:21:08 +00:00
*/
this.enterLandscape = new Phaser.Signal();
/**
2014-11-15 20:01:46 +00:00
* This signal is dispatched when the browser enters portrait orientation, having been in landscape.
*
* This is signaled from `preUpdate` (or `pauseUpdate`) _even when_ the game is paused.
*
* @property {Phaser.Signal} enterPortrait
* @public
2014-11-25 00:23:44 +00:00
* @deprecated 2.2.0 - Use {@link Phaser.ScaleManager#onOrientationChange onOrientationChange}
2013-10-03 00:21:08 +00:00
*/
this.enterPortrait = new Phaser.Signal();
2013-11-28 15:57:09 +00:00
/**
2015-01-06 06:57:25 +00:00
* This signal is dispatched when the browser enters an incorrect orientation, as defined by {@link #forceOrientation}.
2014-11-15 20:01:46 +00:00
*
* This is signaled from `preUpdate` (or `pauseUpdate`) _even when_ the game is paused.
*
* @property {Phaser.Signal} enterIncorrectOrientation
* @public
2013-11-28 15:57:09 +00:00
*/
this.enterIncorrectOrientation = new Phaser.Signal();
/**
2015-01-06 06:57:25 +00:00
* This signal is dispatched when the browser leaves an incorrect orientation, as defined by {@link #forceOrientation}.
2014-11-15 20:01:46 +00:00
*
* This is signaled from `preUpdate` (or `pauseUpdate`) _even when_ the game is paused.
*
2014-11-25 00:23:44 +00:00
* @property {Phaser.Signal} leaveIncorrectOrientation
2014-11-15 20:01:46 +00:00
* @public
2013-11-28 15:57:09 +00:00
*/
this.leaveIncorrectOrientation = new Phaser.Signal();
/**
2014-11-25 00:23:44 +00:00
* If specified, this is the DOM element on which the Fullscreen API enter request will be invoked.
* The target element must have the correct CSS styling and contain the Display canvas.
2014-11-15 20:01:46 +00:00
*
2014-12-03 10:39:11 +00:00
* The elements style will be modified (ie. the width and height might be set to 100%)
2014-11-15 20:01:46 +00:00
* but it will not be added to, removed from, or repositioned within the DOM.
* An attempt is made to restore relevant style changes when fullscreen mode is left.
*
2014-11-25 00:23:44 +00:00
* For pre-2.2.0 behavior set `game.scale.fullScreenTarget = game.canvas`.
2014-11-15 20:01:46 +00:00
*
2014-11-25 00:23:44 +00:00
* @property {?DOMElement} fullScreenTarget
2014-11-15 20:01:46 +00:00
* @default
*/
2014-09-09 14:36:56 +00:00
this.fullScreenTarget = null;
/**
2015-01-06 06:57:25 +00:00
* The fullscreen target, as created by {@link #createFullScreenTarget}.
* This is not set if {@link #fullScreenTarget} is used and is cleared when fullscreen mode ends.
2014-11-25 00:23:44 +00:00
* @property {?DOMElement} _createdFullScreenTarget
* @private
*/
this._createdFullScreenTarget = null;
/**
* This signal is dispatched when fullscreen mode is ready to be initialized but
* before the fullscreen request.
2014-11-15 20:01:46 +00:00
*
2014-11-25 00:23:44 +00:00
* The signal is passed two arguments: `scale` (the ScaleManager), and an object in the form `{targetElement: DOMElement}`.
2014-11-15 20:01:46 +00:00
*
2015-01-06 06:57:25 +00:00
* The `targetElement` is the {@link #fullScreenTarget} element,
* if such is assigned, or a new element created by {@link #createFullScreenTarget}.
2014-11-15 20:01:46 +00:00
*
2014-11-25 00:23:44 +00:00
* Custom CSS styling or resets can be applied to `targetElement` as required.
*
2015-01-06 06:57:25 +00:00
* If `targetElement` is _not_ the same element as {@link #fullScreenTarget}:
2014-11-25 00:23:44 +00:00
* - After initialization the Display canvas is moved onto the `targetElement` for
* the duration of the fullscreen mode, and restored to it's original DOM location when fullscreen is exited.
2015-03-23 23:46:30 +00:00
* - The `targetElement` is moved/re-parented within the DOM and may have its CSS styles updated.
2014-11-25 00:23:44 +00:00
*
* The behavior of a pre-assigned target element is covered in {@link Phaser.ScaleManager#fullScreenTarget fullScreenTarget}.
*
* @property {Phaser.Signal} onFullScreenInit
* @public
2014-11-15 20:01:46 +00:00
*/
2014-11-25 00:23:44 +00:00
this.onFullScreenInit = new Phaser.Signal();
2014-11-15 20:01:46 +00:00
/**
2014-11-25 00:23:44 +00:00
* This signal is dispatched when the browser enters or leaves fullscreen mode, if supported.
*
* The signal is supplied with a single argument: `scale` (the ScaleManager). Use `scale.isFullScreen` to determine
* if currently running in Fullscreen mode.
*
* @property {Phaser.Signal} onFullScreenChange
* @public
2014-11-15 20:01:46 +00:00
*/
2014-11-25 00:23:44 +00:00
this.onFullScreenChange = new Phaser.Signal();
/**
* This signal is dispatched when the browser fails to enter fullscreen mode;
* or if the device does not support fullscreen mode and `startFullScreen` is invoked.
*
* The signal is supplied with a single argument: `scale` (the ScaleManager).
*
* @property {Phaser.Signal} onFullScreenError
* @public
*/
this.onFullScreenError = new Phaser.Signal();
2014-11-15 20:01:46 +00:00
/**
* This signal is dispatched when the browser enters fullscreen mode, if supported.
2014-11-25 00:23:44 +00:00
*
2014-11-15 20:01:46 +00:00
* @property {Phaser.Signal} enterFullScreen
* @public
2014-11-25 00:23:44 +00:00
* @deprecated 2.2.0 - Use {@link Phaser.ScaleManager#onFullScreenChange onFullScreenChange}
*/
this.enterFullScreen = new Phaser.Signal();
/**
2014-11-15 20:01:46 +00:00
* This signal is dispatched when the browser leaves fullscreen mode.
2014-11-25 00:23:44 +00:00
*
2014-11-15 20:01:46 +00:00
* @property {Phaser.Signal} leaveFullScreen
* @public
2014-11-25 00:23:44 +00:00
* @deprecated 2.2.0 - Use {@link Phaser.ScaleManager#onFullScreenChange onFullScreenChange}
*/
this.leaveFullScreen = new Phaser.Signal();
/**
2014-11-15 20:01:46 +00:00
* This signal is dispatched when the browser fails to enter fullscreen mode;
2015-01-06 06:57:25 +00:00
* or if the device does not support fullscreen mode and {@link #startFullScreen} is invoked.
2014-11-25 00:23:44 +00:00
*
* @property {Phaser.Signal} fullScreenFailed
2014-11-15 20:01:46 +00:00
* @public
2014-11-25 00:23:44 +00:00
* @deprecated 2.2.0 - Use {@link Phaser.ScaleManager#onFullScreenError onFullScreenError}
*/
2014-11-25 00:23:44 +00:00
this.fullScreenFailed = this.onFullScreenError;
2014-11-15 20:01:46 +00:00
/**
* The _last known_ orientation of the screen, as defined in the Window Screen Web API.
* See {@link Phaser.DOM.getScreenOrientation} for possible values.
*
* @property {string} screenOrientation
* @readonly
* @public
*/
2014-11-25 00:23:44 +00:00
this.screenOrientation = this.dom.getScreenOrientation();
2013-10-03 00:21:08 +00:00
/**
2014-11-15 20:01:46 +00:00
* The _current_ scale factor based on the game dimensions vs. the scaled dimensions.
* @property {Phaser.Point} scaleFactor
2013-11-28 15:57:09 +00:00
* @readonly
2013-10-03 00:21:08 +00:00
*/
this.scaleFactor = new Phaser.Point(1, 1);
2013-11-28 15:57:09 +00:00
/**
2014-11-15 20:01:46 +00:00
* The _current_ inversed scale factor. The displayed dimensions divided by the game dimensions.
* @property {Phaser.Point} scaleFactorInversed
2013-11-28 15:57:09 +00:00
* @readonly
2014-11-15 20:01:46 +00:00
* @protected
2013-11-28 15:57:09 +00:00
*/
this.scaleFactorInversed = new Phaser.Point(1, 1);
/**
2014-11-25 00:23:44 +00:00
* The Display canvas is aligned by adjusting the margins; the last margins are stored here.
*
2014-11-15 20:01:46 +00:00
* @property {Bounds-like} margin
2013-11-28 15:57:09 +00:00
* @readonly
2014-11-25 00:23:44 +00:00
* @protected
2013-11-28 15:57:09 +00:00
*/
2014-11-15 20:01:46 +00:00
this.margin = {left: 0, top: 0, right: 0, bottom: 0, x: 0, y: 0};
2013-11-28 15:57:09 +00:00
2014-05-20 09:12:48 +00:00
/**
2014-11-15 20:01:46 +00:00
* The bounds of the scaled game. The x/y will match the offset of the canvas element and the width/height the scaled width and height.
* @property {Phaser.Rectangle} bounds
2014-05-20 09:12:48 +00:00
* @readonly
*/
2014-09-09 14:36:56 +00:00
this.bounds = new Phaser.Rectangle();
2014-05-20 09:12:48 +00:00
2013-10-03 00:21:08 +00:00
/**
2014-11-25 00:23:44 +00:00
* The aspect ratio of the scaled Display canvas.
2014-11-15 20:01:46 +00:00
* @property {number} aspectRatio
* @readonly
2013-10-03 00:21:08 +00:00
*/
this.aspectRatio = 0;
/**
2014-11-15 20:01:46 +00:00
* The aspect ratio of the original game dimensions.
* @property {number} sourceAspectRatio
* @readonly
*/
2014-09-09 14:36:56 +00:00
this.sourceAspectRatio = 0;
2013-11-28 15:57:09 +00:00
/**
2014-11-15 20:01:46 +00:00
* The native browser events from Fullscreen API changes.
* @property {any} event
* @readonly
* @private
2013-11-28 15:57:09 +00:00
*/
this.event = null;
2014-11-15 20:01:46 +00:00
/**
2014-11-25 00:23:44 +00:00
* The edges on which to constrain the game Display/canvas in _addition_ to the restrictions of the parent container.
*
* The properties are strings and can be '', 'visual', 'layout', or 'layout-soft'.
* - If 'visual', the edge will be constrained to the Window / displayed screen area
* - If 'layout', the edge will be constrained to the CSS Layout bounds
* - An invalid value is treated as 'visual'
*
* @member
* @property {string} bottom
* @property {string} right
2014-11-15 20:01:46 +00:00
* @default
*/
this.windowConstraints = {
2014-11-25 00:23:44 +00:00
right: 'layout',
bottom: ''
2014-11-15 20:01:46 +00:00
};
/**
2014-11-25 00:23:44 +00:00
* Various compatibility settings.
2015-01-06 06:57:25 +00:00
* A value of "(auto)" indicates the setting is configured based on device and runtime information.
*
2015-03-23 23:46:30 +00:00
* A {@link #refresh} may need to be performed after making changes.
2015-01-06 06:57:25 +00:00
*
2014-11-15 20:01:46 +00:00
* @protected
*
* @property {boolean} [supportsFullscreen=(auto)] - True only if fullscreen support will be used. (Changing to fullscreen still might not work.)
*
* @property {boolean} [orientationFallback=(auto)] - See {@link Phaser.DOM.getScreenOrientation}.
*
2014-11-25 00:23:44 +00:00
* @property {boolean} [noMargins=false] - If true then the Display canvas's margins will not be updated anymore: existing margins must be manually cleared. Disabling margins prevents automatic canvas alignment/centering, possibly in fullscreen.
2014-11-15 20:01:46 +00:00
*
2014-11-25 00:23:44 +00:00
* @property {?Phaser.Point} [scrollTo=(auto)] - If specified the window will be scrolled to this position on every refresh.
2014-11-15 20:01:46 +00:00
*
2015-03-23 23:46:30 +00:00
* @property {boolean} [forceMinimumDocumentHeight=false] - If enabled the document elements minimum height is explicitly set on updates.
2015-01-06 06:57:25 +00:00
* The height set varies by device and may either be the height of the window or the viewport.
2014-11-15 20:01:46 +00:00
*
2014-11-25 00:23:44 +00:00
* @property {boolean} [canExpandParent=true] - If enabled then SHOW_ALL and USER_SCALE modes can try and expand the parent element. It may be necessary for the parent element to impose CSS width/height restrictions.
2015-01-06 06:57:25 +00:00
*
* @property {string} [clickTrampoline=(auto)] - On certain browsers (eg. IE) FullScreen events need to be triggered via 'click' events.
* A value of 'when-not-mouse' uses a click trampoline when a pointer that is not the primary mouse is used.
* Any other string value (including the empty string) prevents using click trampolines.
* For more details on click trampolines see {@link Phaser.Pointer#addClickTrampoline}.
2014-11-15 20:01:46 +00:00
*/
this.compatibility = {
supportsFullScreen: false,
orientationFallback: null,
noMargins: false,
scrollTo: null,
2014-12-03 10:39:11 +00:00
forceMinimumDocumentHeight: false,
2015-01-06 06:57:25 +00:00
canExpandParent: true,
clickTrampoline: ''
2014-11-15 20:01:46 +00:00
};
/**
* Scale mode to be used when not in fullscreen.
* @property {number} _scaleMode
* @private
*/
this._scaleMode = Phaser.ScaleManager.NO_SCALE;
/*
2014-11-15 20:01:46 +00:00
* Scale mode to be used in fullscreen.
* @property {number} _fullScreenScaleMode
* @private
*/
2014-11-15 20:01:46 +00:00
this._fullScreenScaleMode = Phaser.ScaleManager.NO_SCALE;
/**
2015-03-23 23:46:30 +00:00
* If the parent container of the Game canvas is the browser window itself (i.e. document.body),
2015-01-06 06:57:25 +00:00
* rather than another div, this should set to `true`.
*
* The {@link #parentNode} property is generally ignored while this is in effect.
*
2014-11-15 20:01:46 +00:00
* @property {boolean} parentIsWindow
2014-09-09 14:36:56 +00:00
*/
this.parentIsWindow = false;
/**
2014-11-25 00:23:44 +00:00
* The _original_ DOM element for the parent of the Display canvas.
2015-01-06 06:57:25 +00:00
* This may be different in fullscreen - see {@link #createFullScreenTarget}.
*
* This should only be changed after moving the Game canvas to a different DOM parent.
2014-11-15 20:01:46 +00:00
*
2014-11-25 00:23:44 +00:00
* @property {?DOMElement} parentNode
2014-09-09 14:36:56 +00:00
*/
this.parentNode = null;
/**
2014-11-15 20:01:46 +00:00
* The scale of the game in relation to its parent container.
* @property {Phaser.Point} parentScaleFactor
2014-09-09 14:36:56 +00:00
* @readonly
*/
this.parentScaleFactor = new Phaser.Point(1, 1);
/**
2014-11-15 20:01:46 +00:00
* The maximum time (in ms) between dimension update checks for the Canvas's parent element (or window).
* Update checks normally happen quicker in response to other events.
2014-11-25 00:23:44 +00:00
*
2014-11-15 20:01:46 +00:00
* @property {integer} trackParentInterval
2014-09-09 14:36:56 +00:00
* @default
2014-11-15 20:01:46 +00:00
* @protected
2014-11-25 00:23:44 +00:00
* @see {@link Phaser.ScaleManager#refresh refresh}
2014-09-09 14:36:56 +00:00
*/
this.trackParentInterval = 2000;
2014-12-03 10:39:11 +00:00
/**
2014-11-25 00:23:44 +00:00
* This signal is dispatched when the size of the Display canvas changes _or_ the size of the Game changes.
2014-11-15 20:01:46 +00:00
* When invoked this is done _after_ the Canvas size/position have been updated.
*
* This signal is _only_ called when a change occurs and a reflow may be required.
* For example, if the canvas does not change sizes because of CSS settings (such as min-width)
* then this signal will _not_ be triggered.
*
* Use this to handle responsive game layout options.
*
* This is signaled from `preUpdate` (or `pauseUpdate`) _even when_ the game is paused.
*
* @property {Phaser.Signal} onSizeChange
* @todo Formalize the arguments, if any, supplied to this signal.
*/
this.onSizeChange = new Phaser.Signal();
2014-09-09 14:36:56 +00:00
/**
2014-11-15 20:01:46 +00:00
* The callback that will be called each the parent container resizes.
* @property {function} onResize
* @private
2014-09-09 14:36:56 +00:00
*/
this.onResize = null;
/**
2015-01-06 06:57:25 +00:00
* The context in which the {@link #onResize} callback will be called.
2014-11-15 20:01:46 +00:00
* @property {object} onResizeContext
* @private
2014-09-09 14:36:56 +00:00
*/
this.onResizeContext = null;
/**
2014-11-15 20:01:46 +00:00
* Information saved when fullscreen mode is started.
2014-11-25 00:23:44 +00:00
* @property {?object} _fullScreenRestore
* @private
*/
2014-11-15 20:01:46 +00:00
this._fullScreenRestore = null;
/**
2015-01-06 06:57:25 +00:00
* The _actual_ game dimensions, as initially set or set by {@link #setGameSize}.
2014-11-15 20:01:46 +00:00
* @property {Phaser.Rectangle} _gameSize
* @private
*/
this._gameSize = new Phaser.Rectangle();
/**
* The user-supplied scale factor, used with the USER_SCALE scaling mode.
* @property {Phaser.Point} _userScaleFactor
* @private
*/
this._userScaleFactor = new Phaser.Point(1, 1);
2014-11-25 00:23:44 +00:00
/**
* The user-supplied scale trim, used with the USER_SCALE scaling mode.
* @property {Phaser.Point} _userScaleTrim
* @private
*/
this._userScaleTrim = new Phaser.Point(0, 0);
2014-11-15 20:01:46 +00:00
/**
* The last time the bounds were checked in `preUpdate`.
* @property {number} _lastUpdate
* @private
*/
this._lastUpdate = 0;
/**
2014-11-15 20:01:46 +00:00
* Size checks updates are delayed according to the throttle.
* The throttle increases to `trackParentInterval` over time and is used to more
* rapidly detect changes in certain browsers (eg. IE) while providing back-off safety.
* @property {integer} _updateThrottle
* @private
*/
2014-11-15 20:01:46 +00:00
this._updateThrottle = 0;
/**
2014-11-15 20:01:46 +00:00
* The minimum throttle allowed until it has slowed down sufficiently.
* @property {integer} _updateThrottleReset
* @private
*/
2014-11-15 20:01:46 +00:00
this._updateThrottleReset = 100;
2014-05-20 09:12:48 +00:00
/**
2014-11-15 20:01:46 +00:00
* The cached result of the parent (possibly window) bounds; used to invalidate sizing.
* @property {Phaser.Rectangle} _parentBounds
2014-05-20 09:12:48 +00:00
* @private
*/
2014-11-15 20:01:46 +00:00
this._parentBounds = new Phaser.Rectangle();
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
/**
* Temporary bounds used for internal work to cut down on new objects created.
* @property {Phaser.Rectangle} _parentBounds
* @private
*/
this._tempBounds = new Phaser.Rectangle();
2014-09-09 14:36:56 +00:00
/**
2014-11-15 20:01:46 +00:00
* The Canvas size at which the last onSizeChange signal was triggered.
* @property {Phaser.Rectangle} _lastReportedCanvasSize
2014-09-09 14:36:56 +00:00
* @private
*/
2014-11-15 20:01:46 +00:00
this._lastReportedCanvasSize = new Phaser.Rectangle();
2013-10-03 00:21:08 +00:00
2014-09-09 14:36:56 +00:00
/**
2014-11-15 20:01:46 +00:00
* The Game size at which the last onSizeChange signal was triggered.
* @property {Phaser.Rectangle} _lastReportedGameSize
2014-09-09 14:36:56 +00:00
* @private
*/
2014-11-15 20:01:46 +00:00
this._lastReportedGameSize = new Phaser.Rectangle();
2013-11-01 18:16:52 +00:00
2014-09-09 14:36:56 +00:00
if (game.config)
2014-07-10 19:31:11 +00:00
{
2014-09-09 14:36:56 +00:00
this.parseConfig(game.config);
2014-07-10 19:31:11 +00:00
}
2014-09-09 14:36:56 +00:00
this.setupScale(width, height);
2013-10-03 00:21:08 +00:00
};
/**
2014-11-25 00:23:44 +00:00
* A scale mode that stretches content to fill all available space - see {@link Phaser.ScaleManager#scaleMode scaleMode}.
2014-11-15 20:01:46 +00:00
*
2013-10-03 00:21:08 +00:00
* @constant
2014-11-15 20:01:46 +00:00
* @type {integer}
2013-10-03 00:21:08 +00:00
*/
Phaser.ScaleManager.EXACT_FIT = 0;
2013-10-03 00:21:08 +00:00
/**
2014-11-25 00:23:44 +00:00
* A scale mode that prevents any scaling - see {@link Phaser.ScaleManager#scaleMode scaleMode}.
2014-11-15 20:01:46 +00:00
*
2013-10-03 00:21:08 +00:00
* @constant
2014-11-15 20:01:46 +00:00
* @type {integer}
2013-10-03 00:21:08 +00:00
*/
Phaser.ScaleManager.NO_SCALE = 1;
2013-10-03 00:21:08 +00:00
/**
2014-11-25 00:23:44 +00:00
* A scale mode that shows the entire game while maintaining proportions - see {@link Phaser.ScaleManager#scaleMode scaleMode}.
2014-11-15 20:01:46 +00:00
*
2013-10-03 00:21:08 +00:00
* @constant
2014-11-15 20:01:46 +00:00
* @type {integer}
2013-10-03 00:21:08 +00:00
*/
Phaser.ScaleManager.SHOW_ALL = 2;
2013-10-03 00:21:08 +00:00
2014-09-09 14:36:56 +00:00
/**
2014-11-25 00:23:44 +00:00
* A scale mode that causes the Game size to change - see {@link Phaser.ScaleManager#scaleMode scaleMode}.
2014-11-15 20:01:46 +00:00
*
2014-09-09 14:36:56 +00:00
* @constant
2014-11-15 20:01:46 +00:00
* @type {integer}
2014-09-09 14:36:56 +00:00
*/
Phaser.ScaleManager.RESIZE = 3;
2014-11-15 20:01:46 +00:00
/**
2014-11-25 00:23:44 +00:00
* A scale mode that allows a custom scale factor - see {@link Phaser.ScaleManager#scaleMode scaleMode}.
2014-11-15 20:01:46 +00:00
*
* @constant
* @type {integer}
*/
Phaser.ScaleManager.USER_SCALE = 4;
Phaser.ScaleManager.prototype = {
2013-10-03 00:21:08 +00:00
/**
2014-11-15 20:01:46 +00:00
* Start the ScaleManager.
*
* @method Phaser.ScaleManager#boot
* @protected
*/
boot: function () {
// Configure device-dependent compatibility
var compat = this.compatibility;
2015-03-23 23:46:30 +00:00
compat.supportsFullScreen = this.game.device.fullscreen &amp;&amp; !this.game.device.cocoonJS;
2014-11-15 20:01:46 +00:00
// We can't do anything about the status bars in iPads, web apps or desktops
2015-03-23 23:46:30 +00:00
if (!this.game.device.iPad &amp;&amp; !this.game.device.webApp &amp;&amp; !this.game.device.desktop)
2014-11-15 20:01:46 +00:00
{
2015-03-23 23:46:30 +00:00
if (this.game.device.android &amp;&amp; !this.game.device.chrome)
2014-11-15 20:01:46 +00:00
{
compat.scrollTo = new Phaser.Point(0, 1);
}
else
{
compat.scrollTo = new Phaser.Point(0, 0);
}
}
if (this.game.device.desktop)
{
compat.orientationFallback = 'screen';
2015-01-06 06:57:25 +00:00
compat.clickTrampoline = 'when-not-mouse';
2014-11-15 20:01:46 +00:00
}
else
{
compat.orientationFallback = '';
2015-01-06 06:57:25 +00:00
compat.clickTrampoline = '';
2014-11-15 20:01:46 +00:00
}
// Configure event listeners
var _this = this;
this._orientationChange = function(event) {
return _this.orientationChange(event);
};
this._windowResize = function(event) {
return _this.windowResize(event);
};
// This does not appear to be on the standards track
window.addEventListener('orientationchange', this._orientationChange, false);
window.addEventListener('resize', this._windowResize, false);
if (this.compatibility.supportsFullScreen)
{
this._fullScreenChange = function(event) {
return _this.fullScreenChange(event);
};
this._fullScreenError = function(event) {
return _this.fullScreenError(event);
};
document.addEventListener('webkitfullscreenchange', this._fullScreenChange, false);
document.addEventListener('mozfullscreenchange', this._fullScreenChange, false);
document.addEventListener('MSFullscreenChange', this._fullScreenChange, false);
document.addEventListener('fullscreenchange', this._fullScreenChange, false);
document.addEventListener('webkitfullscreenerror', this._fullScreenError, false);
document.addEventListener('mozfullscreenerror', this._fullScreenError, false);
document.addEventListener('MSFullscreenError', this._fullScreenError, false);
document.addEventListener('fullscreenerror', this._fullScreenError, false);
}
this.game.onResume.add(this._gameResumed, this);
// Initialize core bounds
2014-11-25 00:23:44 +00:00
this.dom.getOffset(this.game.canvas, this.offset);
2014-11-15 20:01:46 +00:00
this.bounds.setTo(this.offset.x, this.offset.y, this.width, this.height);
this.setGameSize(this.game.width, this.game.height);
// Don't use updateOrientationState so events are not fired
2014-11-25 00:23:44 +00:00
this.screenOrientation = this.dom.getScreenOrientation(this.compatibility.orientationFallback);
2014-11-15 20:01:46 +00:00
2015-03-23 23:46:30 +00:00
this.grid = new Phaser.FlexGrid(this, this.width, this.height);
2014-11-15 20:01:46 +00:00
},
/**
* Load configuration settings.
2014-09-09 14:36:56 +00:00
*
* @method Phaser.ScaleManager#parseConfig
2014-11-15 20:01:46 +00:00
* @protected
2014-09-09 14:36:56 +00:00
* @param {object} config - The game configuration object.
2013-10-03 00:21:08 +00:00
*/
2014-09-09 14:36:56 +00:00
parseConfig: function (config) {
2013-10-03 00:21:08 +00:00
2014-09-09 14:36:56 +00:00
if (config['scaleMode'])
2013-10-03 00:21:08 +00:00
{
2014-09-09 14:36:56 +00:00
this.scaleMode = config['scaleMode'];
2013-10-03 00:21:08 +00:00
}
2014-09-09 14:36:56 +00:00
if (config['fullScreenScaleMode'])
2013-11-01 18:16:52 +00:00
{
2014-09-09 14:36:56 +00:00
this.fullScreenScaleMode = config['fullScreenScaleMode'];
2013-11-01 18:16:52 +00:00
}
2014-09-09 14:36:56 +00:00
if (config['fullScreenTarget'])
{
this.fullScreenTarget = config['fullScreenTarget'];
}
2013-11-01 18:16:52 +00:00
2014-09-09 14:36:56 +00:00
},
/**
* Calculates and sets the game dimensions based on the given width and height.
2014-11-15 20:01:46 +00:00
*
* This should _not_ be called when in fullscreen mode.
2014-09-09 14:36:56 +00:00
*
* @method Phaser.ScaleManager#setupScale
2014-11-15 20:01:46 +00:00
* @protected
2014-09-09 14:36:56 +00:00
* @param {number|string} width - The width of the game.
* @param {number|string} height - The height of the game.
*/
setupScale: function (width, height) {
var target;
var rect = new Phaser.Rectangle();
if (this.game.parent !== '')
2013-10-03 00:21:08 +00:00
{
2014-09-09 14:36:56 +00:00
if (typeof this.game.parent === 'string')
{
// hopefully an element ID
target = document.getElementById(this.game.parent);
}
2015-03-23 23:46:30 +00:00
else if (this.game.parent &amp;&amp; this.game.parent.nodeType === 1)
2014-09-09 14:36:56 +00:00
{
// quick test for a HTMLelement
target = this.game.parent;
}
}
// Fallback, covers an invalid ID and a non HTMLelement object
if (!target)
{
// Use the full window
this.parentNode = null;
this.parentIsWindow = true;
2014-11-25 00:23:44 +00:00
rect.width = this.dom.visualBounds.width;
rect.height = this.dom.visualBounds.height;
2014-11-15 20:01:46 +00:00
this.offset.set(0, 0);
2013-10-03 00:21:08 +00:00
}
else
2013-10-03 00:21:08 +00:00
{
2014-09-09 14:36:56 +00:00
this.parentNode = target;
this.parentIsWindow = false;
2014-11-15 20:01:46 +00:00
this.getParentBounds(this._parentBounds);
2014-09-09 14:36:56 +00:00
rect.width = this._parentBounds.width;
rect.height = this._parentBounds.height;
2014-11-15 20:01:46 +00:00
this.offset.set(this._parentBounds.x, this._parentBounds.y);
2013-10-03 00:21:08 +00:00
}
2014-09-09 14:36:56 +00:00
var newWidth = 0;
var newHeight = 0;
if (typeof width === 'number')
{
newWidth = width;
}
else
{
// Percentage based
this.parentScaleFactor.x = parseInt(width, 10) / 100;
newWidth = rect.width * this.parentScaleFactor.x;
}
if (typeof height === 'number')
{
newHeight = height;
}
else
{
// Percentage based
this.parentScaleFactor.y = parseInt(height, 10) / 100;
newHeight = rect.height * this.parentScaleFactor.y;
}
2014-11-15 20:01:46 +00:00
this._gameSize.setTo(0, 0, newWidth, newHeight);
2014-09-09 14:36:56 +00:00
this.updateDimensions(newWidth, newHeight, false);
2013-10-03 00:21:08 +00:00
},
/**
2014-11-15 20:01:46 +00:00
* Invoked when the game is resumed.
2014-12-03 10:39:11 +00:00
*
* @method Phaser.ScaleManager#_gameResumed
2014-11-15 20:01:46 +00:00
* @private
2013-10-03 00:21:08 +00:00
*/
2014-12-03 10:39:11 +00:00
_gameResumed: function () {
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
this.queueUpdate(true);
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
},
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
/**
* Set the actual Game size.
* Use this instead of directly changing `game.width` or `game.height`.
*
* The actual physical display (Canvas element size) depends on various settings including
* - Scale mode
* - Scaling factor
* - Size of Canvas's parent element or CSS rules such as min-height/max-height;
* - The size of the Window
*
* @method Phaser.ScaleManager#setGameSize
* @public
* @param {integer} width - _Game width_, in pixels.
* @param {integer} height - _Game height_, in pixels.
*/
setGameSize: function (width, height) {
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
this._gameSize.setTo(0, 0, width, height);
if (this.currentScaleMode !== Phaser.ScaleManager.RESIZE)
2014-09-09 14:36:56 +00:00
{
2014-11-15 20:01:46 +00:00
this.updateDimensions(width, height, true);
2014-09-09 14:36:56 +00:00
}
2014-11-15 20:01:46 +00:00
this.queueUpdate(true);
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
},
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
/**
2014-11-25 00:23:44 +00:00
* Set a User scaling factor used in the USER_SCALE scaling mode.
2014-11-15 20:01:46 +00:00
*
2014-11-25 00:23:44 +00:00
* The target canvas size is computed by:
*
* canvas.width = (game.width * hScale) - hTrim
* canvas.height = (game.height * vScale) - vTrim
*
* This method can be used in the {@link Phaser.ScaleManager#setResizeCallback resize callback}.
*
* @method Phaser.ScaleManager#setUserScale
* @param {number} hScale - Horizontal scaling factor.
* @param {numer} vScale - Vertical scaling factor.
* @param {integer} [hTrim=0] - Horizontal trim, applied after scaling.
* @param {integer} [vTrim=0] - Vertical trim, applied after scaling.
2014-11-15 20:01:46 +00:00
*/
2014-11-25 00:23:44 +00:00
setUserScale: function (hScale, vScale, hTrim, vTrim) {
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
this._userScaleFactor.setTo(hScale, vScale);
this._userScaleTrim.setTo(hTrim | 0, vTrim | 0);
2014-11-15 20:01:46 +00:00
this.queueUpdate(true);
2013-10-03 00:21:08 +00:00
},
2013-11-01 18:16:52 +00:00
/**
2014-12-03 10:39:11 +00:00
* Sets the callback that will be invoked before sizing calculations.
2014-11-25 00:23:44 +00:00
*
2015-01-06 06:57:25 +00:00
* This is the appropriate place to call {@link #setUserScale} if needing custom dynamic scaling.
2014-11-25 00:23:44 +00:00
*
* The callback is supplied with two arguments `scale` and `parentBounds` where `scale` is the ScaleManager
* and `parentBounds`, a Phaser.Rectangle, is the size of the Parent element.
2014-11-15 20:01:46 +00:00
*
* This callback
* - May be invoked even though the parent container or canvas sizes have not changed
2015-01-06 06:57:25 +00:00
* - Unlike {@link #onSizeChange}, it runs _before_ the canvas is guaranteed to be updated
2014-11-25 00:23:44 +00:00
* - Will be invoked from `preUpdate`, _even when_ the game is paused
2014-11-15 20:01:46 +00:00
*
2015-01-06 06:57:25 +00:00
* See {@link #onSizeChange} for a better way of reacting to layout updates.
2014-09-09 14:36:56 +00:00
*
* @method Phaser.ScaleManager#setResizeCallback
2014-11-15 20:01:46 +00:00
* @public
2014-09-09 14:36:56 +00:00
* @param {function} callback - The callback that will be called each time a window.resize event happens or if set, the parent container resizes.
* @param {object} context - The context in which the callback will be called.
2013-11-01 18:16:52 +00:00
*/
2014-09-09 14:36:56 +00:00
setResizeCallback: function (callback, context) {
2013-11-01 18:16:52 +00:00
2014-09-09 14:36:56 +00:00
this.onResize = callback;
this.onResizeContext = context;
2013-11-28 15:57:09 +00:00
2014-09-09 14:36:56 +00:00
},
/**
2014-11-25 00:23:44 +00:00
* Signals a resize - IF the canvas or Game size differs from the last signal.
2014-11-15 20:01:46 +00:00
*
2015-01-06 06:57:25 +00:00
* This also triggers updates on {@link #grid} (FlexGrid) and, if in a RESIZE mode, `game.state` (StateManager).
2014-11-15 20:01:46 +00:00
*
2015-03-23 23:46:30 +00:00
* @method Phaser.ScaleManager#signalSizeChange
2014-11-15 20:01:46 +00:00
* @private
*/
signalSizeChange: function () {
if (!Phaser.Rectangle.sameDimensions(this, this._lastReportedCanvasSize) ||
!Phaser.Rectangle.sameDimensions(this.game, this._lastReportedGameSize))
{
var width = this.width;
var height = this.height;
this._lastReportedCanvasSize.setTo(0, 0, width, height);
this._lastReportedGameSize.setTo(0, 0, this.game.width, this.game.height);
this.grid.onResize(width, height);
this.onSizeChange.dispatch(this, width, height);
// Per StateManager#onResizeCallback, it only occurs when in RESIZE mode.
if (this.currentScaleMode === Phaser.ScaleManager.RESIZE)
{
this.game.state.resize(width, height);
this.game.load.resize(width, height);
}
}
},
/**
2014-11-25 00:23:44 +00:00
* Set the min and max dimensions for the Display canvas.
*
* _Note:_ The min/max dimensions are only applied in some cases
* - When the device is not in an incorrect orientation; or
* - The scale mode is EXACT_FIT when not in fullscreen
2014-11-15 20:01:46 +00:00
*
* @method Phaser.ScaleManager#setMinMax
* @public
* @param {number} minWidth - The minimum width the game is allowed to scale down to.
* @param {number} minHeight - The minimum height the game is allowed to scale down to.
* @param {number} [maxWidth] - The maximum width the game is allowed to scale up to; only changed if specified.
* @param {number} [maxHeight] - The maximum height the game is allowed to scale up to; only changed if specified.
* @todo These values are only sometimes honored.
*/
2014-09-09 14:36:56 +00:00
setMinMax: function (minWidth, minHeight, maxWidth, maxHeight) {
this.minWidth = minWidth;
this.minHeight = minHeight;
if (typeof maxWidth !== 'undefined')
2013-11-01 18:16:52 +00:00
{
2014-09-09 14:36:56 +00:00
this.maxWidth = maxWidth;
}
2013-11-01 18:16:52 +00:00
2014-09-09 14:36:56 +00:00
if (typeof maxHeight !== 'undefined')
{
this.maxHeight = maxHeight;
}
2013-11-01 18:16:52 +00:00
2014-09-09 14:36:56 +00:00
},
2013-11-01 18:16:52 +00:00
2014-09-09 14:36:56 +00:00
/**
* The ScaleManager.preUpdate is called automatically by the core Game loop.
*
* @method Phaser.ScaleManager#preUpdate
* @protected
*/
preUpdate: function () {
2014-11-15 20:01:46 +00:00
if (this.game.time.time &lt; (this._lastUpdate + this._updateThrottle))
2014-09-09 14:36:56 +00:00
{
return;
}
2014-11-15 20:01:46 +00:00
var prevThrottle = this._updateThrottle;
this._updateThrottleReset = prevThrottle >= 400 ? 0 : 100;
2014-11-25 00:23:44 +00:00
this.dom.getOffset(this.game.canvas, this.offset);
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
var prevWidth = this._parentBounds.width;
var prevHeight = this._parentBounds.height;
var bounds = this.getParentBounds(this._parentBounds);
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
var boundsChanged = bounds.width !== prevWidth || bounds.height !== prevHeight;
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
// Always invalidate on a newly detected orientation change
2014-11-25 00:23:44 +00:00
var orientationChanged = this.updateOrientationState();
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
if (boundsChanged || orientationChanged)
{
if (this.onResize)
{
2014-11-25 00:23:44 +00:00
this.onResize.call(this.onResizeContext, this, bounds);
2014-11-15 20:01:46 +00:00
}
2014-11-25 00:23:44 +00:00
this.updateLayout();
2014-11-15 20:01:46 +00:00
this.signalSizeChange();
}
// Next throttle, eg. 25, 50, 100, 200..
var throttle = this._updateThrottle * 2;
// Don't let an update be too eager about resetting the throttle.
if (this._updateThrottle &lt; prevThrottle)
{
throttle = Math.min(prevThrottle, this._updateThrottleReset);
}
this._updateThrottle = Phaser.Math.clamp(throttle, 25, this.trackParentInterval);
this._lastUpdate = this.game.time.time;
},
2014-12-03 10:39:11 +00:00
/**
* Update method while paused.
*
* @method Phaser.ScaleManager#pauseUpdate
* @private
*/
2014-11-15 20:01:46 +00:00
pauseUpdate: function () {
this.preUpdate();
// Updates at slowest.
this._updateThrottle = this.trackParentInterval;
},
/**
* Update the dimensions taking the parent scaling factor into account.
*
* @method Phaser.ScaleManager#updateDimensions
* @private
* @param {number} width - The new width of the parent container.
* @param {number} height - The new height of the parent container.
* @param {boolean} resize - True if the renderer should be resized, otherwise false to just update the internal vars.
*/
updateDimensions: function (width, height, resize) {
this.width = width * this.parentScaleFactor.x;
this.height = height * this.parentScaleFactor.y;
this.game.width = this.width;
2014-09-09 14:36:56 +00:00
this.game.height = this.height;
this.sourceAspectRatio = this.width / this.height;
2014-11-15 20:01:46 +00:00
this.updateScalingAndBounds();
2014-09-09 14:36:56 +00:00
if (resize)
2013-11-01 18:16:52 +00:00
{
2014-11-25 00:23:44 +00:00
// Resize the renderer (which in turn resizes the Display canvas!)
2014-09-09 14:36:56 +00:00
this.game.renderer.resize(this.width, this.height);
2013-11-01 18:16:52 +00:00
2014-11-25 00:23:44 +00:00
// The Camera can never be smaller than the Game size
2014-09-09 14:36:56 +00:00
this.game.camera.setSize(this.width, this.height);
2013-11-01 18:16:52 +00:00
2014-09-09 14:36:56 +00:00
// This should only happen if the world is smaller than the new canvas size
this.game.world.resize(this.width, this.height);
}
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
},
2014-11-15 20:01:46 +00:00
/**
* Update relevant scaling values based on the ScaleManager dimension and game dimensions,
2015-01-06 06:57:25 +00:00
* which should already be set. This does not change {@link #sourceAspectRatio}.
2014-12-03 10:39:11 +00:00
*
* @method Phaser.ScaleManager#updateScalingAndBounds
2014-11-15 20:01:46 +00:00
* @private
*/
updateScalingAndBounds: function () {
this.scaleFactor.x = this.game.width / this.width;
this.scaleFactor.y = this.game.height / this.height;
this.scaleFactorInversed.x = this.width / this.game.width;
this.scaleFactorInversed.y = this.height / this.game.height;
this.aspectRatio = this.width / this.height;
// This can be invoked in boot pre-canvas
if (this.game.canvas)
2014-09-09 14:36:56 +00:00
{
2014-11-25 00:23:44 +00:00
this.dom.getOffset(this.game.canvas, this.offset);
2013-11-01 18:16:52 +00:00
}
2015-03-23 23:46:30 +00:00
2014-11-15 20:01:46 +00:00
this.bounds.setTo(this.offset.x, this.offset.y, this.width, this.height);
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
// Can be invoked in boot pre-input
2015-03-23 23:46:30 +00:00
if (this.game.input &amp;&amp; this.game.input.scale)
2014-11-15 20:01:46 +00:00
{
this.game.input.scale.setTo(this.scaleFactor.x, this.scaleFactor.y);
}
2014-09-09 14:36:56 +00:00
2013-11-01 18:16:52 +00:00
},
/**
2014-11-15 20:01:46 +00:00
* Force the game to run in only one orientation.
*
* This enables generation of incorrect orientation signals and affects resizing but does not otherwise rotate or lock the orientation.
2015-03-23 23:46:30 +00:00
*
* Orientation checks are performed via the Screen Orientation API, if available in browser. This means it will check your monitor
* orientation on desktop, or your device orientation on mobile, rather than comparing actual game dimensions. If you need to check the
* viewport dimensions instead and bypass the Screen Orientation API then set: `ScaleManager.compatibility.orientationFallback = 'viewport'`
2014-09-09 14:36:56 +00:00
*
* @method Phaser.ScaleManager#forceOrientation
2014-11-15 20:01:46 +00:00
* @public
* @param {boolean} forceLandscape - true if the game should run in landscape mode only.
2013-11-28 15:57:09 +00:00
* @param {boolean} [forcePortrait=false] - true if the game should run in portrait mode only.
*/
2014-09-09 14:36:56 +00:00
forceOrientation: function (forceLandscape, forcePortrait) {
2013-11-28 15:57:09 +00:00
if (typeof forcePortrait === 'undefined') { forcePortrait = false; }
2013-11-28 15:57:09 +00:00
this.forceLandscape = forceLandscape;
this.forcePortrait = forcePortrait;
2014-11-25 00:23:44 +00:00
this.queueUpdate(true);
2014-11-15 20:01:46 +00:00
},
/**
* Classify the orientation, per `getScreenOrientation`.
2014-12-03 10:39:11 +00:00
*
2014-11-15 20:01:46 +00:00
* @method Phaser.ScaleManager#classifyOrientation
* @private
* @param {string} orientation - The orientation string, e.g. 'portrait-primary'.
2014-11-25 00:23:44 +00:00
* @return {?string} The classified orientation: 'portrait', 'landscape`, or null.
2014-11-15 20:01:46 +00:00
*/
classifyOrientation: function (orientation) {
if (orientation === 'portrait-primary' || orientation === 'portrait-secondary')
{
return 'portrait';
}
else if (orientation === 'landscape-primary' || orientation === 'landscape-secondary')
{
return 'landscape';
}
else
{
return null;
}
},
2013-10-03 00:21:08 +00:00
/**
2014-11-15 20:01:46 +00:00
* Updates the current orientation and dispatches orientation change events.
2014-09-09 14:36:56 +00:00
*
2014-11-15 20:01:46 +00:00
* @method Phaser.ScaleManager#updateOrientationState
* @private
* @return {boolean} True if the orientation state changed which means a forced update is likely required.
2013-10-03 00:21:08 +00:00
*/
2014-11-25 00:23:44 +00:00
updateOrientationState: function () {
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
var previousOrientation = this.screenOrientation;
2014-11-25 00:23:44 +00:00
var previouslyIncorrect = this.incorrectOrientation;
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
this.screenOrientation = this.dom.getScreenOrientation(this.compatibility.orientationFallback);
2015-03-23 23:46:30 +00:00
this.incorrectOrientation = (this.forceLandscape &amp;&amp; !this.isLandscape) ||
(this.forcePortrait &amp;&amp; !this.isPortrait);
2014-11-15 20:01:46 +00:00
var changed = previousOrientation !== this.screenOrientation;
2014-11-25 00:23:44 +00:00
var correctnessChanged = previouslyIncorrect !== this.incorrectOrientation;
2014-11-15 20:01:46 +00:00
if (changed)
2013-10-03 00:21:08 +00:00
{
2014-11-15 20:01:46 +00:00
if (this.isLandscape)
2013-10-03 00:21:08 +00:00
{
2014-11-15 20:01:46 +00:00
this.enterLandscape.dispatch(this.orientation, true, false);
}
else
{
this.enterPortrait.dispatch(this.orientation, false, true);
2013-10-03 00:21:08 +00:00
}
}
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
if (correctnessChanged)
{
2014-11-25 00:23:44 +00:00
if (this.incorrectOrientation)
{
this.enterIncorrectOrientation.dispatch();
}
else
{
this.leaveIncorrectOrientation.dispatch();
2013-10-03 00:21:08 +00:00
}
}
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
if (changed || correctnessChanged)
{
this.onOrientationChange.dispatch(this, previousOrientation, previouslyIncorrect);
}
return changed || correctnessChanged;
2014-11-15 20:01:46 +00:00
2013-10-03 00:21:08 +00:00
},
/**
2014-09-09 14:36:56 +00:00
* window.orientationchange event handler.
*
2014-11-15 20:01:46 +00:00
* @method Phaser.ScaleManager#orientationChange
* @private
2013-10-03 00:21:08 +00:00
* @param {Event} event - The orientationchange event data.
*/
2014-11-15 20:01:46 +00:00
orientationChange: function (event) {
2013-10-03 00:21:08 +00:00
2013-11-28 15:57:09 +00:00
this.event = event;
2014-11-15 20:01:46 +00:00
this.queueUpdate(true);
2013-10-03 00:21:08 +00:00
},
/**
2014-09-09 14:36:56 +00:00
* window.resize event handler.
*
2014-11-15 20:01:46 +00:00
* @method Phaser.ScaleManager#windowResize
* @private
2013-10-03 00:21:08 +00:00
* @param {Event} event - The resize event data.
*/
2014-11-15 20:01:46 +00:00
windowResize: function (event) {
2013-10-03 00:21:08 +00:00
2013-11-28 15:57:09 +00:00
this.event = event;
2014-11-15 20:01:46 +00:00
this.queueUpdate(true);
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
},
/**
* Scroll to the top - in some environments. See `compatibility.scrollTo`.
2014-12-03 10:39:11 +00:00
*
* @method Phaser.ScaleManager#scrollTop
2014-11-15 20:01:46 +00:00
* @private
*/
scrollTop: function () {
var scrollTo = this.compatibility.scrollTo;
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
if (scrollTo)
2013-10-03 00:21:08 +00:00
{
2014-11-15 20:01:46 +00:00
window.scrollTo(scrollTo.x, scrollTo.y);
2013-10-03 00:21:08 +00:00
}
2014-11-15 20:01:46 +00:00
},
/**
2015-01-06 06:57:25 +00:00
* The "refresh" methods informs the ScaleManager that a layout refresh is required.
2014-11-25 00:23:44 +00:00
*
* The ScaleManager automatically queues a layout refresh (eg. updates the Game size or Display canvas layout)
* when the browser is resized, the orientation changes, or when there is a detected change
* of the Parent size. Refreshing is also done automatically when public properties,
2015-01-06 06:57:25 +00:00
* such as {@link #scaleMode}, are updated or state-changing methods are invoked.
2014-11-25 00:23:44 +00:00
*
2015-01-06 06:57:25 +00:00
* The "refresh" method _may_ need to be used in a few (rare) situtations when
2014-11-25 00:23:44 +00:00
*
* - a device change event is not correctly detected; or
* - the Parent size changes (and an immediate reflow is desired); or
2015-01-06 06:57:25 +00:00
* - the ScaleManager state is updated by non-standard means; or
* - certain {@link #compatibility} properties are manually changed.
2014-11-25 00:23:44 +00:00
*
* The queued layout refresh is not immediate but will run promptly in an upcoming `preRender`.
2014-11-15 20:01:46 +00:00
*
* @method Phaser.ScaleManager#refresh
* @public
*/
refresh: function () {
this.scrollTop();
this.queueUpdate(true);
},
/**
2014-11-25 00:23:44 +00:00
* Updates the game / canvas position and size.
2014-11-15 20:01:46 +00:00
*
2014-11-25 00:23:44 +00:00
* @method Phaser.ScaleManager#updateLayout
* @private
2014-11-15 20:01:46 +00:00
*/
2014-11-25 00:23:44 +00:00
updateLayout: function () {
2014-11-15 20:01:46 +00:00
var scaleMode = this.currentScaleMode;
if (scaleMode === Phaser.ScaleManager.RESIZE)
2013-10-03 00:21:08 +00:00
{
2014-11-15 20:01:46 +00:00
this.reflowGame();
return;
2013-10-03 00:21:08 +00:00
}
2014-11-15 20:01:46 +00:00
this.scrollTop();
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
if (this.compatibility.forceMinimumDocumentHeight)
{
// (This came from older code, by why is it here?)
// Set minimum height of content to new window height
document.documentElement.style.minHeight = window.innerHeight + 'px';
2013-10-03 00:21:08 +00:00
}
2014-11-15 20:01:46 +00:00
if (this.incorrectOrientation)
2013-10-03 00:21:08 +00:00
{
2014-11-15 20:01:46 +00:00
this.setMaximum();
}
else
{
if (scaleMode === Phaser.ScaleManager.EXACT_FIT)
2014-09-09 14:36:56 +00:00
{
2014-11-15 20:01:46 +00:00
this.setExactFit();
2014-09-09 14:36:56 +00:00
}
2014-11-15 20:01:46 +00:00
else if (scaleMode === Phaser.ScaleManager.SHOW_ALL)
2014-09-09 14:36:56 +00:00
{
2015-03-23 23:46:30 +00:00
if (!this.isFullScreen &amp;&amp; this.boundingParent &amp;&amp;
2014-11-25 00:23:44 +00:00
this.compatibility.canExpandParent)
2014-11-15 20:01:46 +00:00
{
// Try to expand parent out, but choosing maximizing dimensions.
// Then select minimize dimensions which should then honor parent
// maximum bound applications.
this.setShowAll(true);
this.resetCanvas();
this.setShowAll();
}
else
{
this.setShowAll();
}
2014-09-09 14:36:56 +00:00
}
2014-11-15 20:01:46 +00:00
else if (scaleMode === Phaser.ScaleManager.NO_SCALE)
{
this.width = this.game.width;
this.height = this.game.height;
}
else if (scaleMode === Phaser.ScaleManager.USER_SCALE)
2014-09-09 14:36:56 +00:00
{
2014-11-25 00:23:44 +00:00
this.width = (this.game.width * this._userScaleFactor.x) - this._userScaleTrim.x;
this.height = (this.game.height * this._userScaleFactor.y) - this._userScaleTrim.y;
2014-09-09 14:36:56 +00:00
}
2013-10-03 00:21:08 +00:00
}
2015-03-23 23:46:30 +00:00
if (!this.compatibility.canExpandParent &amp;&amp;
2014-11-25 00:23:44 +00:00
(scaleMode === Phaser.ScaleManager.SHOW_ALL || scaleMode === Phaser.ScaleManager.USER_SCALE))
{
var bounds = this.getParentBounds(this._tempBounds);
this.width = Math.min(this.width, bounds.width);
this.height = Math.min(this.height, bounds.height);
}
// Always truncate / force to integer
this.width = this.width | 0;
this.height = this.height | 0;
2014-11-15 20:01:46 +00:00
this.reflowCanvas();
2014-10-22 20:49:44 +00:00
2013-10-03 00:21:08 +00:00
},
/**
2014-11-25 00:23:44 +00:00
* Returns the computed Parent size/bounds that the Display canvas is allowed/expected to fill.
*
2015-01-06 06:57:25 +00:00
* If in fullscreen mode or without parent (see {@link #parentIsWindow}),
2014-11-25 00:23:44 +00:00
* this will be the bounds of the visual viewport itself.
2014-11-15 20:01:46 +00:00
*
2015-01-06 06:57:25 +00:00
* This function takes the {@link #windowConstraints} into consideration - if the parent is partially outside
2014-11-25 00:23:44 +00:00
* the viewport then this function may return a smaller than expected size.
2014-11-15 20:01:46 +00:00
*
2014-11-25 00:23:44 +00:00
* Values are rounded to the nearest pixel.
2014-11-15 20:01:46 +00:00
*
* @method Phaser.ScaleManager#getParentBounds
* @protected
* @param {Phaser.Rectangle} [target=(new Rectangle)] - The rectangle to update; a new one is created as needed.
2014-11-25 00:23:44 +00:00
* @return {Phaser.Rectangle} The established parent bounds.
2013-10-03 00:21:08 +00:00
*/
2014-11-15 20:01:46 +00:00
getParentBounds: function (target) {
var bounds = target || new Phaser.Rectangle();
2014-11-25 00:23:44 +00:00
var parentNode = this.boundingParent;
var visualBounds = this.dom.visualBounds;
var layoutBounds = this.dom.layoutBounds;
2013-10-03 00:21:08 +00:00
2014-11-25 00:23:44 +00:00
if (!parentNode)
2013-10-03 00:21:08 +00:00
{
2014-11-25 00:23:44 +00:00
bounds.setTo(0, 0, visualBounds.width, visualBounds.height);
2014-11-15 20:01:46 +00:00
}
else
{
2014-11-25 00:23:44 +00:00
// Ref. http://msdn.microsoft.com/en-us/library/hh781509(v=vs.85).aspx for getBoundingClientRect
2014-11-15 20:01:46 +00:00
var clientRect = parentNode.getBoundingClientRect();
bounds.setTo(clientRect.left, clientRect.top, clientRect.width, clientRect.height);
var wc = this.windowConstraints;
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
if (wc.right)
2013-10-03 00:21:08 +00:00
{
2014-11-25 00:23:44 +00:00
var windowBounds = wc.right === 'layout' ? layoutBounds : visualBounds;
bounds.right = Math.min(bounds.right, windowBounds.width);
2013-10-03 00:21:08 +00:00
}
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
if (wc.bottom)
2013-10-03 00:21:08 +00:00
{
2014-11-25 00:23:44 +00:00
var windowBounds = wc.bottom === 'layout' ? layoutBounds : visualBounds;
bounds.bottom = Math.min(bounds.bottom, windowBounds.height);
2013-10-03 00:21:08 +00:00
}
}
2014-11-15 20:01:46 +00:00
bounds.setTo(
Math.round(bounds.x), Math.round(bounds.y),
Math.round(bounds.width), Math.round(bounds.height));
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
return bounds;
2013-10-03 00:21:08 +00:00
},
/**
2014-11-15 20:01:46 +00:00
* Update the canvas position/margins - for alignment within the parent container.
*
* The canvas margins _must_ be reset/cleared prior to invoking this.
*
* @method Phaser.ScaleManager#alignCanvas
* @private
* @param {boolean} horizontal - Align horizontally?
* @param {boolean} vertical - Align vertically?
2013-10-03 00:21:08 +00:00
*/
2014-11-15 20:01:46 +00:00
alignCanvas: function (horizontal, vertical) {
2013-10-03 00:21:08 +00:00
2014-11-25 00:23:44 +00:00
var parentBounds = this.getParentBounds(this._tempBounds);
2014-11-15 20:01:46 +00:00
var canvas = this.game.canvas;
var margin = this.margin;
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
if (horizontal)
2013-10-03 00:21:08 +00:00
{
2014-11-15 20:01:46 +00:00
margin.left = margin.right = 0;
2014-11-15 20:01:46 +00:00
var canvasBounds = canvas.getBoundingClientRect();
2015-03-23 23:46:30 +00:00
if (this.width &lt; parentBounds.width &amp;&amp; !this.incorrectOrientation)
2013-10-03 00:21:08 +00:00
{
2014-11-15 20:01:46 +00:00
var currentEdge = canvasBounds.left - parentBounds.x;
var targetEdge = (parentBounds.width / 2) - (this.width / 2);
targetEdge = Math.max(targetEdge, 0);
var offset = targetEdge - currentEdge;
margin.left = Math.round(offset);
2013-10-03 00:21:08 +00:00
}
2014-11-15 20:01:46 +00:00
canvas.style.marginLeft = margin.left + 'px';
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
if (margin.left !== 0)
2013-10-03 00:21:08 +00:00
{
2014-11-15 20:01:46 +00:00
margin.right = -(parentBounds.width - canvasBounds.width - margin.left);
canvas.style.marginRight = margin.right + 'px';
2013-10-03 00:21:08 +00:00
}
}
2014-11-15 20:01:46 +00:00
if (vertical)
2013-10-03 00:21:08 +00:00
{
2014-11-15 20:01:46 +00:00
margin.top = margin.bottom = 0;
2014-11-15 20:01:46 +00:00
var canvasBounds = canvas.getBoundingClientRect();
2015-03-23 23:46:30 +00:00
if (this.height &lt; parentBounds.height &amp;&amp; !this.incorrectOrientation)
2013-10-03 00:21:08 +00:00
{
2014-11-15 20:01:46 +00:00
var currentEdge = canvasBounds.top - parentBounds.y;
var targetEdge = (parentBounds.height / 2) - (this.height / 2);
targetEdge = Math.max(targetEdge, 0);
var offset = targetEdge - currentEdge;
margin.top = Math.round(offset);
2013-10-03 00:21:08 +00:00
}
2014-11-15 20:01:46 +00:00
canvas.style.marginTop = margin.top + 'px';
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
if (margin.top !== 0)
2013-10-03 00:21:08 +00:00
{
2014-11-15 20:01:46 +00:00
margin.bottom = -(parentBounds.height - canvasBounds.height - margin.top);
canvas.style.marginBottom = margin.bottom + 'px';
2013-10-03 00:21:08 +00:00
}
}
2014-11-15 20:01:46 +00:00
// Silly backwards compatibility..
margin.x = margin.left;
margin.y = margin.top;
2013-10-03 00:21:08 +00:00
},
/**
2014-11-25 00:23:44 +00:00
* Updates the Game state / size.
2014-11-15 20:01:46 +00:00
*
2014-11-25 00:23:44 +00:00
* The canvas margins may always be adjusted, even if alignment is not in effect.
2014-09-09 14:36:56 +00:00
*
2014-11-15 20:01:46 +00:00
* @method Phaser.ScaleManager#reflowGame
* @private
2013-10-03 00:21:08 +00:00
*/
2014-12-03 10:39:11 +00:00
reflowGame: function () {
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
this.resetCanvas('', '');
2013-10-03 00:21:08 +00:00
2014-11-25 00:23:44 +00:00
var bounds = this.getParentBounds(this._tempBounds);
2014-11-15 20:01:46 +00:00
this.updateDimensions(bounds.width, bounds.height, true);
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
},
2014-11-15 20:01:46 +00:00
/**
2014-11-25 00:23:44 +00:00
* Updates the Display canvas size.
2014-11-15 20:01:46 +00:00
*
* The canvas margins may always be adjusted, even alignment is not in effect.
*
* @method Phaser.ScaleManager#reflowCanvas
* @private
*/
reflowCanvas: function () {
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
if (!this.incorrectOrientation)
2013-10-03 00:21:08 +00:00
{
2014-11-15 20:01:46 +00:00
this.width = Phaser.Math.clamp(this.width, this.minWidth || 0, this.maxWidth || this.width);
this.height = Phaser.Math.clamp(this.height, this.minHeight || 0, this.maxHeight || this.height);
2013-10-03 00:21:08 +00:00
}
2014-11-15 20:01:46 +00:00
this.resetCanvas();
if (!this.compatibility.noMargins)
2013-10-03 00:21:08 +00:00
{
2015-03-23 23:46:30 +00:00
if (this.isFullScreen &amp;&amp; this._createdFullScreenTarget)
2013-10-03 00:21:08 +00:00
{
2014-11-15 20:01:46 +00:00
this.alignCanvas(true, true);
2013-10-03 00:21:08 +00:00
}
else
{
2014-11-15 20:01:46 +00:00
this.alignCanvas(this.pageAlignHorizontally, this.pageAlignVertically);
2013-10-03 00:21:08 +00:00
}
}
2014-11-15 20:01:46 +00:00
this.updateScalingAndBounds();
2014-05-20 09:12:48 +00:00
2014-11-15 20:01:46 +00:00
},
2014-11-15 20:01:46 +00:00
/**
2014-11-25 00:23:44 +00:00
* "Reset" the Display canvas and set the specified width/height.
*
2014-11-15 20:01:46 +00:00
* @method Phaser.ScaleManager#resetCanvas
* @private
* @param {string} [cssWidth=(current width)] - The css width to set.
* @param {string} [cssHeight=(current height)] - The css height to set.
*/
resetCanvas: function (cssWidth, cssHeight) {
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
if (typeof cssWidth === 'undefined') { cssWidth = this.width + 'px'; }
if (typeof cssHeight === 'undefined') { cssHeight = this.height + 'px'; }
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
var canvas = this.game.canvas;
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
if (!this.compatibility.noMargins)
{
canvas.style.marginLeft = '';
canvas.style.marginTop = '';
canvas.style.marginRight = '';
canvas.style.marginBottom = '';
}
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
canvas.style.width = cssWidth;
canvas.style.height = cssHeight;
2013-10-03 00:21:08 +00:00
},
2014-11-15 20:01:46 +00:00
/**
* Queues/marks a size/bounds check as needing to occur (from `preUpdate`).
2014-11-25 00:23:44 +00:00
*
2014-11-15 20:01:46 +00:00
* @method Phaser.ScaleManager#queueUpdate
* @private
* @param {boolean} force - If true resets the parent bounds to ensure the check is dirty.
*/
queueUpdate: function (force) {
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
if (force)
{
this._parentBounds.width = 0;
this._parentBounds.height = 0;
}
this._updateThrottle = this._updateThrottleReset;
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
},
/**
* Reset internal data/state.
*
* @method Phaser.ScaleManager#reset
* @private
*/
2014-09-09 14:36:56 +00:00
reset: function (clearWorld) {
if (clearWorld)
{
this.grid.reset();
}
},
2013-10-03 00:21:08 +00:00
/**
2014-11-15 20:01:46 +00:00
* Updates the width/height to that of the window.
2014-09-09 14:36:56 +00:00
*
* @method Phaser.ScaleManager#setMaximum
2014-11-15 20:01:46 +00:00
* @private
2013-10-03 00:21:08 +00:00
*/
setMaximum: function () {
2014-11-25 00:23:44 +00:00
this.width = this.dom.visualBounds.width;
this.height = this.dom.visualBounds.height;
2013-10-03 00:21:08 +00:00
},
/**
2014-11-15 20:01:46 +00:00
* Updates the width/height such that the game is scaled proportionally.
2014-09-09 14:36:56 +00:00
*
* @method Phaser.ScaleManager#setShowAll
2014-11-15 20:01:46 +00:00
* @private
* @param {boolean} expanding - If true then the maximizing dimension is chosen.
2013-10-03 00:21:08 +00:00
*/
2014-11-15 20:01:46 +00:00
setShowAll: function (expanding) {
2013-10-03 00:21:08 +00:00
2014-11-25 00:23:44 +00:00
var bounds = this.getParentBounds(this._tempBounds);
2014-11-15 20:01:46 +00:00
var width = bounds.width;
var height = bounds.height;
var multiplier;
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
if (expanding)
{
multiplier = Math.max((height / this.game.height), (width / this.game.width));
}
else
{
multiplier = Math.min((height / this.game.height), (width / this.game.width));
}
2013-10-03 00:21:08 +00:00
this.width = Math.round(this.game.width * multiplier);
this.height = Math.round(this.game.height * multiplier);
},
/**
2014-11-15 20:01:46 +00:00
* Updates the width/height such that the game is stretched to the available size.
2015-01-06 06:57:25 +00:00
* Honors {@link #maxWidth} and {@link #maxHeight} when _not_ in fullscreen.
2014-11-15 20:01:46 +00:00
*
* @method Phaser.ScaleManager#setExactFit
2014-11-15 20:01:46 +00:00
* @private
2013-10-03 00:21:08 +00:00
*/
setExactFit: function () {
2014-11-25 00:23:44 +00:00
var bounds = this.getParentBounds(this._tempBounds);
2013-10-03 00:21:08 +00:00
2014-11-15 20:01:46 +00:00
this.width = bounds.width;
this.height = bounds.height;
if (this.isFullScreen)
2013-10-03 00:21:08 +00:00
{
2014-11-15 20:01:46 +00:00
// Max/min not honored fullscreen
return;
2013-10-03 00:21:08 +00:00
}
2014-11-15 20:01:46 +00:00
if (this.maxWidth)
2013-10-03 00:21:08 +00:00
{
2014-11-15 20:01:46 +00:00
this.width = Math.min(this.width, this.maxWidth);
2013-10-03 00:21:08 +00:00
}
2014-11-15 20:01:46 +00:00
if (this.maxHeight)
2013-10-03 00:21:08 +00:00
{
2014-11-15 20:01:46 +00:00
this.height = Math.min(this.height, this.maxHeight);
2013-10-03 00:21:08 +00:00
}
2014-09-09 14:36:56 +00:00
},
2014-11-25 00:23:44 +00:00
/**
* Creates a fullscreen target. This is called automatically as as needed when entering
2015-01-06 06:57:25 +00:00
* fullscreen mode and the resulting element is supplied to {@link #onFullScreenInit}.
2014-11-25 00:23:44 +00:00
*
2015-01-06 06:57:25 +00:00
* Use {@link #onFullScreenInit} to customize the created object.
2014-11-25 00:23:44 +00:00
*
* @method Phaser.ScaleManager#createFullScreenTarget
* @protected
*/
createFullScreenTarget: function () {
2014-12-03 10:39:11 +00:00
2014-11-25 00:23:44 +00:00
var fsTarget = document.createElement('div');
2014-12-03 10:39:11 +00:00
2014-11-25 00:23:44 +00:00
fsTarget.style.margin = '0';
fsTarget.style.padding = '0';
fsTarget.style.background = '#000';
2014-12-03 10:39:11 +00:00
2014-11-25 00:23:44 +00:00
return fsTarget;
2014-12-03 10:39:11 +00:00
2014-11-25 00:23:44 +00:00
},
2014-09-09 14:36:56 +00:00
/**
2014-12-03 10:39:11 +00:00
* Start the browsers fullscreen mode - this _must_ be called from a user input Pointer or Mouse event.
2014-11-15 20:01:46 +00:00
*
2014-11-25 00:23:44 +00:00
* The Fullscreen API must be supported by the browser for this to work - it is not the same as setting
2015-01-06 06:57:25 +00:00
* the game size to fill the browser window. See {@link Phaser.ScaleManager#compatibility compatibility.supportsFullScreen} to check if the current
2014-11-25 00:23:44 +00:00
* device is reported to support fullscreen mode.
2014-11-15 20:01:46 +00:00
*
2015-01-06 06:57:25 +00:00
* The {@link #fullScreenFailed} signal will be dispatched if the fullscreen change request failed or the game does not support the Fullscreen API.
2014-11-15 20:01:46 +00:00
*
2014-09-09 14:36:56 +00:00
* @method Phaser.ScaleManager#startFullScreen
2014-11-15 20:01:46 +00:00
* @public
* @param {boolean} [antialias] - 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.
2014-12-03 10:39:11 +00:00
* @param {boolean} [allowTrampoline=undefined] - Internal argument. If `false` click trampolining is suppressed.
2014-11-15 20:01:46 +00:00
* @return {boolean} 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.)
2014-09-09 14:36:56 +00:00
*/
2014-11-15 20:01:46 +00:00
startFullScreen: function (antialias, allowTrampoline) {
if (this.isFullScreen)
{
return false;
}
if (!this.compatibility.supportsFullScreen)
{
// Error is called in timeout to emulate the real fullscreenerror event better
var _this = this;
setTimeout(function () {
_this.fullScreenError();
}, 10);
return;
}
2014-09-09 14:36:56 +00:00
2015-01-06 06:57:25 +00:00
if (this.compatibility.clickTrampoline === 'when-not-mouse')
2014-09-09 14:36:56 +00:00
{
2015-01-06 06:57:25 +00:00
var input = this.game.input;
2015-03-23 23:46:30 +00:00
if (input.activePointer &amp;&amp;
input.activePointer !== input.mousePointer &amp;&amp;
2015-01-06 06:57:25 +00:00
(allowTrampoline || allowTrampoline !== false))
{
input.activePointer.addClickTrampoline("startFullScreen", this.startFullScreen, this, [antialias, false]);
return;
}
2014-09-09 14:36:56 +00:00
}
2015-03-23 23:46:30 +00:00
if (typeof antialias !== 'undefined' &amp;&amp; this.game.renderType === Phaser.CANVAS)
2014-09-09 14:36:56 +00:00
{
this.game.stage.smoothed = antialias;
}
2014-11-15 20:01:46 +00:00
var fsTarget = this.fullScreenTarget;
if (!fsTarget)
{
this.cleanupCreatedTarget();
this._createdFullScreenTarget = this.createFullScreenTarget();
fsTarget = this._createdFullScreenTarget;
2014-11-25 00:23:44 +00:00
}
var initData = {
targetElement: fsTarget
};
2014-12-03 10:39:11 +00:00
2014-11-25 00:23:44 +00:00
this.onFullScreenInit.dispatch(this, initData);
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
if (this._createdFullScreenTarget)
{
// Move the Display canvas inside of the target and add the target to the DOM
2014-11-15 20:01:46 +00:00
// (The target has to be added for the Fullscreen API to work.)
var canvas = this.game.canvas;
var parent = canvas.parentNode;
parent.insertBefore(fsTarget, canvas);
fsTarget.appendChild(canvas);
}
2014-09-09 14:36:56 +00:00
if (this.game.device.fullscreenKeyboard)
{
2014-11-15 20:01:46 +00:00
fsTarget[this.game.device.requestFullscreen](Element.ALLOW_KEYBOARD_INPUT);
2014-09-09 14:36:56 +00:00
}
else
{
2014-11-15 20:01:46 +00:00
fsTarget[this.game.device.requestFullscreen]();
2014-09-09 14:36:56 +00:00
}
2014-11-15 20:01:46 +00:00
return true;
2014-09-09 14:36:56 +00:00
},
/**
2014-11-25 00:23:44 +00:00
* Stops / exits fullscreen mode, if active.
2014-11-15 20:01:46 +00:00
*
2014-09-09 14:36:56 +00:00
* @method Phaser.ScaleManager#stopFullScreen
2014-11-15 20:01:46 +00:00
* @public
* @return {boolean} Returns true if the browser supports fullscreen mode and fullscreen mode will be exited.
2014-09-09 14:36:56 +00:00
*/
stopFullScreen: function () {
2014-11-15 20:01:46 +00:00
if (!this.isFullScreen || !this.compatibility.supportsFullScreen)
{
return false;
}
2014-09-09 14:36:56 +00:00
document[this.game.device.cancelFullscreen]();
2014-11-15 20:01:46 +00:00
return true;
},
/**
* Cleans up the previous fullscreen target, if such was automatically created.
* This ensures the canvas is restored to its former parent, assuming the target didn't move.
2014-11-25 00:23:44 +00:00
*
2014-12-03 10:39:11 +00:00
* @method Phaser.ScaleManager#cleanupCreatedTarget
2014-11-15 20:01:46 +00:00
* @private
*/
cleanupCreatedTarget: function () {
var fsTarget = this._createdFullScreenTarget;
2014-12-03 10:39:11 +00:00
2015-03-23 23:46:30 +00:00
if (fsTarget &amp;&amp; fsTarget.parentNode)
2014-11-15 20:01:46 +00:00
{
// Make sure to cleanup synthetic target for sure;
// swap the canvas back to the parent.
var parent = fsTarget.parentNode;
parent.insertBefore(this.game.canvas, fsTarget);
parent.removeChild(fsTarget);
}
this._createdFullScreenTarget = null;
},
/**
* Used to prepare/restore extra fullscreen mode settings.
* (This does move any elements within the DOM tree.)
*
* @method Phaser.ScaleManager#prepScreenMode
* @private
* @param {boolean} enteringFullscreen - True if _entering_ fullscreen, false if _leaving_.
*/
prepScreenMode: function (enteringFullscreen) {
var createdTarget = !!this._createdFullScreenTarget;
var fsTarget = this._createdFullScreenTarget || this.fullScreenTarget;
if (enteringFullscreen)
{
if (createdTarget || this.fullScreenScaleMode === Phaser.ScaleManager.EXACT_FIT)
{
// Resize target, as long as it's not the canvas
if (fsTarget !== this.game.canvas)
{
this._fullScreenRestore = {
targetWidth: fsTarget.style.width,
targetHeight: fsTarget.style.height
};
fsTarget.style.width = '100%';
fsTarget.style.height = '100%';
}
}
}
else
{
// Have restore information
if (this._fullScreenRestore)
{
fsTarget.style.width = this._fullScreenRestore.targetWidth;
fsTarget.style.height = this._fullScreenRestore.targetHeight;
this._fullScreenRestore = null;
}
// Always reset to game size
this.updateDimensions(this._gameSize.width, this._gameSize.height, true);
this.resetCanvas();
}
2014-09-09 14:36:56 +00:00
},
/**
2014-11-15 20:01:46 +00:00
* Called automatically when the browser enters of leaves fullscreen mode.
*
2014-09-09 14:36:56 +00:00
* @method Phaser.ScaleManager#fullScreenChange
2014-11-25 00:23:44 +00:00
* @private
2014-11-15 20:01:46 +00:00
* @param {Event} [event=undefined] - The fullscreenchange event
2014-09-09 14:36:56 +00:00
*/
fullScreenChange: function (event) {
this.event = event;
if (this.isFullScreen)
{
2014-11-15 20:01:46 +00:00
this.prepScreenMode(true);
2014-09-09 14:36:56 +00:00
2014-11-25 00:23:44 +00:00
this.updateLayout();
2014-11-15 20:01:46 +00:00
this.queueUpdate(true);
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
this.enterFullScreen.dispatch(this.width, this.height);
}
else
{
this.prepScreenMode(false);
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
this.cleanupCreatedTarget();
2014-09-09 14:36:56 +00:00
2014-11-25 00:23:44 +00:00
this.updateLayout();
2014-11-15 20:01:46 +00:00
this.queueUpdate(true);
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
this.leaveFullScreen.dispatch(this.width, this.height);
2014-09-09 14:36:56 +00:00
}
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
this.onFullScreenChange.dispatch(this);
2014-11-15 20:01:46 +00:00
},
/**
* Called automatically when the browser fullscreen request fails;
* or called when a fullscreen request is made on a device for which it is not supported.
*
* @method Phaser.ScaleManager#fullScreenError
2014-11-25 00:23:44 +00:00
* @private
2014-11-15 20:01:46 +00:00
* @param {Event} [event=undefined] - The fullscreenerror event; undefined if invoked on a device that does not support the Fullscreen API.
*/
fullScreenError: function (event) {
this.event = event;
this.cleanupCreatedTarget();
console.warn('Phaser.ScaleManager: requestFullscreen failed or device does not support the Fullscreen API');
2014-11-25 00:23:44 +00:00
this.onFullScreenError.dispatch(this);
2014-11-15 20:01:46 +00:00
},
/**
* Takes a Sprite or Image object and scales it to fit the given dimensions.
* Scaling happens proportionally without distortion to the sprites texture.
* The letterBox parameter controls if scaling will produce a letter-box effect or zoom the
* sprite until it fills the given values. Note that with letterBox set to false the scaled sprite may spill out over either
* the horizontal or vertical sides of the target dimensions. If you wish to stop this you can crop the Sprite.
*
* @method Phaser.ScaleManager#scaleSprite
* @protected
* @param {Phaser.Sprite|Phaser.Image} sprite - The sprite we want to scale.
* @param {integer} [width] - The target width that we want to fit the sprite in to. If not given it defaults to ScaleManager.width.
* @param {integer} [height] - The target height that we want to fit the sprite in to. If not given it defaults to ScaleManager.height.
* @param {boolean} [letterBox=false] - True if we want the `fitted` mode. Otherwise, the function uses the `zoom` mode.
* @return {Phaser.Sprite|Phaser.Image} The scaled sprite.
*/
scaleSprite: function (sprite, width, height, letterBox) {
if (typeof width === 'undefined') { width = this.width; }
if (typeof height === 'undefined') { height = this.height; }
if (typeof letterBox === 'undefined') { letterBox = false; }
sprite.scale.set(1);
if ((sprite.width &lt;= 0) || (sprite.height &lt;= 0) || (width &lt;= 0) || (height &lt;= 0))
2014-09-09 14:36:56 +00:00
{
2014-11-15 20:01:46 +00:00
return sprite;
}
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
var scaleX1 = width;
var scaleY1 = (sprite.height * width) / sprite.width;
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
var scaleX2 = (sprite.width * height) / sprite.height;
var scaleY2 = height;
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
var scaleOnWidth = (scaleX2 > width);
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
if (scaleOnWidth)
{
scaleOnWidth = letterBox;
2014-09-09 14:36:56 +00:00
}
2014-11-15 20:01:46 +00:00
else
{
scaleOnWidth = !letterBox;
}
if (scaleOnWidth)
{
sprite.width = Math.floor(scaleX1);
sprite.height = Math.floor(scaleY1);
}
else
{
sprite.width = Math.floor(scaleX2);
sprite.height = Math.floor(scaleY2);
}
// Enable at some point?
// sprite.x = Math.floor((width - sprite.width) / 2);
// sprite.y = Math.floor((height - sprite.height) / 2);
return sprite;
2014-09-09 14:36:56 +00:00
},
/**
2014-11-15 20:01:46 +00:00
* Destroys the ScaleManager and removes any event listeners.
* This should probably only be called when the game is destroyed.
*
2014-11-25 00:23:44 +00:00
* @method Phaser.ScaleManager#destroy
2014-11-15 20:01:46 +00:00
* @protected
*/
2014-09-09 14:36:56 +00:00
destroy: function () {
2014-11-15 20:01:46 +00:00
this.game.onResume.remove(this._gameResumed, this);
window.removeEventListener('orientationchange', this._orientationChange, false);
window.removeEventListener('resize', this._windowResize, false);
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
if (this.compatibility.supportsFullScreen)
2014-09-09 14:36:56 +00:00
{
document.removeEventListener('webkitfullscreenchange', this._fullScreenChange, false);
document.removeEventListener('mozfullscreenchange', this._fullScreenChange, false);
2014-11-15 20:01:46 +00:00
document.removeEventListener('MSFullscreenChange', this._fullScreenChange, false);
2014-09-09 14:36:56 +00:00
document.removeEventListener('fullscreenchange', this._fullScreenChange, false);
2014-11-15 20:01:46 +00:00
document.removeEventListener('webkitfullscreenerror', this._fullScreenError, false);
document.removeEventListener('mozfullscreenerror', this._fullScreenError, false);
document.removeEventListener('MSFullscreenError', this._fullScreenError, false);
document.removeEventListener('fullscreenerror', this._fullScreenError, false);
2014-09-09 14:36:56 +00:00
}
2013-10-03 00:21:08 +00:00
}
};
Phaser.ScaleManager.prototype.constructor = Phaser.ScaleManager;
2014-02-05 06:29:17 +00:00
2014-09-09 14:36:56 +00:00
/**
2014-11-15 20:01:46 +00:00
* window.resize event handler.
* @method checkResize
* @memberof Phaser.ScaleManager
* @protected
2014-11-25 00:23:44 +00:00
* @deprecated 2.2.0 - This method is INTERNAL: avoid using it directly.
2014-11-15 20:01:46 +00:00
*/
Phaser.ScaleManager.prototype.checkResize = Phaser.ScaleManager.prototype.windowResize;
/**
* window.orientationchange event handler.
* @method checkOrientation
* @memberof Phaser.ScaleManager
* @protected
2014-11-25 00:23:44 +00:00
* @deprecated 2.2.0 - This method is INTERNAL: avoid using it directly.
2014-11-15 20:01:46 +00:00
*/
Phaser.ScaleManager.prototype.checkOrientation = Phaser.ScaleManager.prototype.orientationChange;
/**
2014-11-25 00:23:44 +00:00
* Updates the size of the Game or the size/position of the Display canvas based on internal state.
*
* Do not call this directly. To "refresh" the layout use {@link Phaser.ScaleManager#refresh refresh}.
* To precisely control the scaling/size, apply appropriate rules to the bounding Parent container or
* use the {@link Phaser.ScaleManager#scaleMode USER_SCALE scale mode}.
*
* @method Phaser.ScaleManager#setScreenSize
* @protected
* @deprecated 2.2.0 - This method is INTERNAL: avoid using it directly.
*/
Phaser.ScaleManager.prototype.setScreenSize = Phaser.ScaleManager.prototype.updateLayout;
/**
* Updates the size/position of the Display canvas based on internal state.
*
* Do not call this directly. To "refresh" the layout use {@link Phaser.ScaleManager#refresh refresh}.
* To precisely control the scaling/size, apply appropriate rules to the bounding Parent container or
* use the {@link Phaser.ScaleManager#scaleMode USER_SCALE scale mode}.
*
2014-11-15 20:01:46 +00:00
* @method setSize
* @memberof Phaser.ScaleManager
* @protected
2014-11-25 00:23:44 +00:00
* @deprecated 2.2.0 - This method is INTERNAL: avoid using it directly.
2014-11-15 20:01:46 +00:00
*/
Phaser.ScaleManager.prototype.setSize = Phaser.ScaleManager.prototype.reflowCanvas;
/**
2015-01-06 06:57:25 +00:00
* Checks if the browser is in the correct orientation for the game,
* dependent upon {@link #forceLandscape} and {@link #forcePortrait}, and updates the state.
2014-11-15 20:01:46 +00:00
*
* The appropriate event is dispatched if the orientation became valid or invalid.
*
* @method checkOrientationState
* @memberof Phaser.ScaleManager
* @protected
* @return {boolean} True if the orientation state changed (consider a refresh)
* @deprecated 2.2.0 - This is only for backward compatibility of user code.
*/
Phaser.ScaleManager.prototype.checkOrientationState = function () {
var changed = this.updateOrientationState();
2015-03-23 23:46:30 +00:00
2014-11-15 20:01:46 +00:00
if (changed)
{
this.refresh();
}
2015-03-23 23:46:30 +00:00
2014-11-15 20:01:46 +00:00
return changed;
};
/**
2014-11-25 00:23:44 +00:00
* The DOM element that is considered the Parent bounding element, if any.
2014-11-15 20:01:46 +00:00
*
2015-01-06 06:57:25 +00:00
* This `null` if {@link #parentIsWindow} is true or if fullscreen mode is entered and {@link #fullScreenTarget} is specified.
2014-11-25 00:23:44 +00:00
* It will also be null if there is no game canvas or if the game canvas has no parent.
*
2014-12-03 10:39:11 +00:00
* @name Phaser.ScaleManager#boundingParent
2014-11-25 00:23:44 +00:00
* @property {?DOMElement} boundingParent
* @readonly
*/
Object.defineProperty(Phaser.ScaleManager.prototype, "boundingParent", {
get: function () {
if (this.parentIsWindow ||
2015-03-23 23:46:30 +00:00
(this.isFullScreen &amp;&amp; !this._createdFullScreenTarget))
2014-11-25 00:23:44 +00:00
{
return null;
}
2015-03-23 23:46:30 +00:00
var parentNode = this.game.canvas &amp;&amp; this.game.canvas.parentNode;
2014-11-25 00:23:44 +00:00
return parentNode || null;
}
});
/**
* The scaling method used by the ScaleManager when not in fullscreen.
*
* &lt;dl>
* &lt;dt>{@link Phaser.ScaleManager.NO_SCALE}&lt;/dt>
* &lt;dd>
* The Game display area will not be scaled - even if it is too large for the canvas/screen.
* This mode _ignores_ any applied scaling factor and displays the canvas at the Game size.
* &lt;/dd>
* &lt;dt>{@link Phaser.ScaleManager.EXACT_FIT}&lt;/dt>
* &lt;dd>
* The Game display area will be _stretched_ to fill the entire size of the canvas's parent element and/or screen.
* Proportions are not mainted.
* &lt;/dd>
* &lt;dt>{@link Phaser.ScaleManager.SHOW_ALL}&lt;/dt>
* &lt;dd>
* Show the entire game display area while _maintaining_ the original aspect ratio.
* &lt;/dd>
* &lt;dt>{@link Phaser.ScaleManager.RESIZE}&lt;/dt>
* &lt;dd>
* The dimensions of the game display area are changed to match the size of the parent container.
* That is, this mode _changes the Game size_ to match the display size.
* &lt;p>
2015-01-06 06:57:25 +00:00
* Any manually set Game size (see {@link #setGameSize}) is ignored while in effect.
2014-11-25 00:23:44 +00:00
* &lt;/dd>
* &lt;dt>{@link Phaser.ScaleManager.USER_SCALE}&lt;/dt>
* &lt;dd>
* The game Display is scaled according to the user-specified scale set by {@link Phaser.ScaleManager#setUserScale setUserScale}.
* &lt;p>
* This scale can be adjusted in the {@link Phaser.ScaleManager#setResizeCallback resize callback}
* for flexible custom-sizing needs.
* &lt;/dd>
* &lt;/dl>
2014-11-15 20:01:46 +00:00
*
2014-09-09 14:36:56 +00:00
* @name Phaser.ScaleManager#scaleMode
2014-11-25 00:23:44 +00:00
* @property {integer} scaleMode
2014-09-09 14:36:56 +00:00
*/
Object.defineProperty(Phaser.ScaleManager.prototype, "scaleMode", {
get: function () {
return this._scaleMode;
},
set: function (value) {
if (value !== this._scaleMode)
{
2014-11-15 20:01:46 +00:00
if (!this.isFullScreen)
{
this.updateDimensions(this._gameSize.width, this._gameSize.height, true);
this.queueUpdate(true);
}
2014-09-09 14:36:56 +00:00
this._scaleMode = value;
}
2014-11-15 20:01:46 +00:00
return this._scaleMode;
}
});
/**
* The scaling method used by the ScaleManager when in fullscreen.
*
2014-11-25 00:23:44 +00:00
* See {@link Phaser.ScaleManager#scaleMode scaleMode} for the different modes allowed.
*
2014-11-15 20:01:46 +00:00
* @name Phaser.ScaleManager#fullScreenScaleMode
2014-11-25 00:23:44 +00:00
* @property {integer} fullScreenScaleMode
2014-11-15 20:01:46 +00:00
*/
Object.defineProperty(Phaser.ScaleManager.prototype, "fullScreenScaleMode", {
get: function () {
return this._fullScreenScaleMode;
},
set: function (value) {
if (value !== this._fullScreenScaleMode)
{
// If in fullscreen then need a wee bit more work
if (this.isFullScreen)
{
this.prepScreenMode(false);
this._fullScreenScaleMode = value;
this.prepScreenMode(true);
this.queueUpdate(true);
}
else
{
this._fullScreenScaleMode = value;
}
}
return this._fullScreenScaleMode;
}
});
/**
* Returns the current scale mode - for normal or fullscreen operation.
*
2014-11-25 00:23:44 +00:00
* See {@link Phaser.ScaleManager#scaleMode scaleMode} for the different modes allowed.
*
2014-11-15 20:01:46 +00:00
* @name Phaser.ScaleManager#currentScaleMode
* @property {number} currentScaleMode
* @protected
* @readonly
*/
Object.defineProperty(Phaser.ScaleManager.prototype, "currentScaleMode", {
get: function () {
return this.isFullScreen ? this._fullScreenScaleMode : this._scaleMode;
2014-09-09 14:36:56 +00:00
}
});
2013-10-03 00:21:08 +00:00
/**
2015-01-06 06:57:25 +00:00
* When enabled the Display canvas will be horizontally-aligned _in the Parent container_ (or {@link Phaser.ScaleManager#parentIsWindow window}).
2014-11-15 20:01:46 +00:00
*
2015-01-06 06:57:25 +00:00
* To align horizontally across the page the Display canvas should be added directly to page;
* or the parent container should itself be horizontally aligned.
2014-11-15 20:01:46 +00:00
*
2015-01-06 06:57:25 +00:00
* Horizontal alignment is not applicable with the {@link .RESIZE} scaling mode.
2014-11-15 20:01:46 +00:00
*
* @name Phaser.ScaleManager#pageAlignHorizontally
* @property {boolean} pageAlignHorizontally
* @default false
*/
Object.defineProperty(Phaser.ScaleManager.prototype, "pageAlignHorizontally", {
get: function () {
return this._pageAlignHorizontally;
},
set: function (value) {
if (value !== this._pageAlignHorizontally)
{
this._pageAlignHorizontally = value;
this.queueUpdate(true);
}
}
});
/**
2015-01-06 06:57:25 +00:00
* When enabled the Display canvas will be vertically-aligned _in the Parent container_ (or {@link Phaser.ScaleManager#parentIsWindow window}).
*
* To align vertically the Parent element should have a _non-collapsible_ height, such that it will maintain
* a height _larger_ than the height of the contained Game canvas - the game canvas will then be scaled vertically
* _within_ the remaining available height dictated by the Parent element.
*
* One way to prevent the parent from collapsing is to add an absolute "min-height" CSS property to the parent element.
* If specifying a relative "min-height/height" or adjusting margins, the Parent height must still be non-collapsible (see note).
2014-11-15 20:01:46 +00:00
*
2015-01-06 06:57:25 +00:00
* _Note_: In version 2.2 the minimum document height is _not_ automatically set to the viewport/window height.
* To automatically update the minimum document height set {@link Phaser.ScaleManager#compatibility compatibility.forceMinimumDocumentHeight} to true.
2014-11-15 20:01:46 +00:00
*
2015-01-06 06:57:25 +00:00
* Vertical alignment is not applicable with the {@link .RESIZE} scaling mode.
2014-11-15 20:01:46 +00:00
*
* @name Phaser.ScaleManager#pageAlignVertically
* @property {boolean} pageAlignVertically
* @default false
*/
Object.defineProperty(Phaser.ScaleManager.prototype, "pageAlignVertically", {
get: function () {
return this._pageAlignVertically;
},
set: function (value) {
if (value !== this._pageAlignVertically)
{
this._pageAlignVertically = value;
this.queueUpdate(true);
}
}
});
/**
* Returns true if the browser is in fullscreen mode, otherwise false.
* @name Phaser.ScaleManager#isFullScreen
2014-11-15 20:01:46 +00:00
* @property {boolean} isFullScreen
2013-10-03 00:21:08 +00:00
* @readonly
*/
Object.defineProperty(Phaser.ScaleManager.prototype, "isFullScreen", {
2013-10-03 00:21:08 +00:00
get: function () {
2014-11-15 20:01:46 +00:00
return !!(document['fullscreenElement'] ||
document['webkitFullscreenElement'] ||
document['mozFullScreenElement'] ||
document['msFullscreenElement']);
2013-10-03 00:21:08 +00:00
}
});
/**
2015-03-23 23:46:30 +00:00
* Returns true if the screen orientation is in portrait mode.
2014-11-25 00:23:44 +00:00
*
* @name Phaser.ScaleManager#isPortrait
2014-11-15 20:01:46 +00:00
* @property {boolean} isPortrait
2013-10-03 00:21:08 +00:00
* @readonly
*/
Object.defineProperty(Phaser.ScaleManager.prototype, "isPortrait", {
2013-10-03 00:21:08 +00:00
get: function () {
2014-11-15 20:01:46 +00:00
return this.classifyOrientation(this.screenOrientation) === 'portrait';
2013-10-03 00:21:08 +00:00
}
});
/**
2015-03-23 23:46:30 +00:00
* Returns true if the screen orientation is in landscape mode.
2014-11-25 00:23:44 +00:00
*
* @name Phaser.ScaleManager#isLandscape
2014-11-15 20:01:46 +00:00
* @property {boolean} isLandscape
2013-10-03 00:21:08 +00:00
* @readonly
*/
Object.defineProperty(Phaser.ScaleManager.prototype, "isLandscape", {
2013-10-03 00:21:08 +00:00
get: function () {
2014-11-15 20:01:46 +00:00
return this.classifyOrientation(this.screenOrientation) === 'landscape';
}
});
/**
2015-03-23 23:46:30 +00:00
* The _last known_ orientation value of the screen. A value of 90 is landscape and 0 is portrait.
2014-11-25 00:23:44 +00:00
* @name Phaser.ScaleManager#orientation
* @property {integer} orientation
2014-11-15 20:01:46 +00:00
* @readonly
2015-01-06 06:57:25 +00:00
* @deprecated 2.2.0 - Use {@link #screenOrientation} instead.
2014-11-15 20:01:46 +00:00
*/
Object.defineProperty(Phaser.ScaleManager.prototype, "orientation", {
2015-03-23 23:46:30 +00:00
get: function () {
2014-11-15 20:01:46 +00:00
return (this.classifyOrientation(this.screenOrientation) === 'portrait' ? 0 : 90);
2013-10-03 00:21:08 +00:00
}
2015-03-23 23:46:30 +00:00
});
/**
* Returns true if the game dimensions are portrait (height > width).
* This is especially useful to check when using the RESIZE scale mode
* but wanting to maintain game orientation on desktop browsers,
* where typically the screen orientation will always be landscape regardless of the browser viewport.
*
* @name Phaser.ScaleManager#isGamePortrait
* @property {boolean} isGamePortrait
* @readonly
*/
Object.defineProperty(Phaser.ScaleManager.prototype, "isGamePortrait", {
get: function () {
return (this.height > this.width);
}
});
/**
* Returns true if the game dimensions are landscape (width > height).
* This is especially useful to check when using the RESIZE scale mode
* but wanting to maintain game orientation on desktop browsers,
* where typically the screen orientation will always be landscape regardless of the browser viewport.
*
* @name Phaser.ScaleManager#isGameLandscape
* @property {boolean} isGameLandscape
* @readonly
*/
Object.defineProperty(Phaser.ScaleManager.prototype, "isGameLandscape", {
get: function () {
return (this.width > this.height);
}
2013-10-03 00:21:08 +00:00
});
</pre>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
2015-03-23 23:46:30 +00:00
Phaser Copyright © 2012-2015 Photon Storm Ltd.
2013-10-03 00:21:08 +00:00
</span>
<br />
<span class="jsdoc-message">
2015-03-23 23:46:30 +00:00
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha10</a>
2015-03-26 02:55:18 +00:00
on Thu Mar 26 2015 02:53:48 GMT+0000 (GMT Standard Time) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
2013-10-03 00:21:08 +00:00
</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( {
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
2013-10-03 00:21:08 +00:00
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>