Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-12-11 22:03:09 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/v2/docs/Phaser.ScaleManager.html
Richard Davey c298a45d1f Updated folder paths and the 2.7 README.
2016-11-23 00:17:46 +00:00

7361 lines
No EOL
137 KiB
HTML
Executable file
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: ScaleManager</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/default.css">
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div 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>
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser API</a>
<ul class="nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="Phaser.html">Phaser</a>
</li>
<li class="class-depth-0">
<a href="PIXI.html">PIXI</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="Event.html">Event</a>
</li>
<li class="class-depth-0">
<a href="EventTarget.html">EventTarget</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Animation.html">Animation</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationManager.html">AnimationManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArraySet.html">ArraySet</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArrayUtils.html">ArrayUtils</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Bullet.html">Bullet</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Button.html">Button</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
</li>
<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>
<li class="class-depth-1">
<a href="Phaser.Create.html">Create</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Creature.html">Creature</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Device.html">Device</a>
</li>
<li class="class-depth-1">
<a href="Phaser.DeviceButton.html">DeviceButton</a>
</li>
<li class="class-depth-1">
<a href="Phaser.DOM.html">DOM</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Easing.html">Easing</a>
</li>
<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>
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Events.html">Events</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Filter.html">Filter</a>
</li>
<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>
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Game.html">Game</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Group.html">Group</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Hermite.html">Hermite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ImageCollection.html">ImageCollection</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Input.html">Input</a>
</li>
<li class="class-depth-1">
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Key.html">Key</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
<li class="class-depth-1">
<a href="Phaser.KeyCode.html">KeyCode</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Line.html">Line</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Loader.html">Loader</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LoaderParser.html">LoaderParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Math.html">Math</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Matrix.html">Matrix</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Mouse.html">Mouse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Net.html">Net</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Path.html">Path</a>
</li>
<li class="class-depth-1">
<a href="Phaser.PathFollower.html">PathFollower</a>
</li>
<li class="class-depth-1">
<a href="Phaser.PathPoint.html">PathPoint</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Physics.html">Physics</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.TilemapCollision.html">TilemapCollision</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
<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>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Plugin.html">Plugin</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Plugin.PathManager.html">PathManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Point.html">Point</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Pointer.html">Pointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.PointerMode.html">PointerMode</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RoundedRectangle.html">RoundedRectangle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sound.html">Sound</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="Phaser.State.html">State</a>
</li>
<li class="class-depth-1">
<a href="Phaser.StateManager.html">StateManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Text.html">Text</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tile.html">Tile</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tileset.html">Tileset</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Time.html">Time</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Timer.html">Timer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Touch.html">Touch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TweenData.html">TweenData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Video.html">Video</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Weapon.html">Weapon</a>
</li>
<li class="class-depth-1">
<a href="Phaser.World.html">World</a>
</li>
<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.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.CanvasPool.html">CanvasPool</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.DisplayObjectContainer.html">DisplayObjectContainer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.EarCut.html">EarCut</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-2">
<a href="PIXI.PIXI.DisplayObject.html">DisplayObject</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">
<a href="PIXI.PrimitiveShader.html">PrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Strip.html">Strip</a>
</li>
<li class="class-depth-1">
<a href="PIXI.StripShader.html">StripShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Texture.html">Texture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TilingSprite.html">TilingSprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLRenderer.html">WebGLRenderer</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="global.html#ANGLE_DOWN">ANGLE_DOWN</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_LEFT">ANGLE_LEFT</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_NORTH_EAST">ANGLE_NORTH_EAST</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_NORTH_WEST">ANGLE_NORTH_WEST</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_RIGHT">ANGLE_RIGHT</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_SOUTH_EAST">ANGLE_SOUTH_EAST</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_SOUTH_WEST">ANGLE_SOUTH_WEST</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_UP">ANGLE_UP</a>
</li>
<li class="class-depth-0">
<a href="global.html#AUTO">AUTO</a>
</li>
<li class="class-depth-0">
<a href="global.html#BITMAPDATA">BITMAPDATA</a>
</li>
<li class="class-depth-0">
<a href="global.html#BITMAPTEXT">BITMAPTEXT</a>
</li>
<li class="class-depth-0">
<a href="global.html#blendModes">blendModes</a>
</li>
<li class="class-depth-0">
<a href="global.html#BOTTOM_CENTER">BOTTOM_CENTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#BOTTOM_LEFT">BOTTOM_LEFT</a>
</li>
<li class="class-depth-0">
<a href="global.html#BOTTOM_RIGHT">BOTTOM_RIGHT</a>
</li>
<li class="class-depth-0">
<a href="global.html#BUTTON">BUTTON</a>
</li>
<li class="class-depth-0">
<a href="global.html#CANVAS">CANVAS</a>
</li>
<li class="class-depth-0">
<a href="global.html#CANVAS_FILTER">CANVAS_FILTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#CENTER">CENTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#CIRCLE">CIRCLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#CREATURE">CREATURE</a>
</li>
<li class="class-depth-0">
<a href="global.html#displayList">displayList</a>
</li>
<li class="class-depth-0">
<a href="global.html#DOWN">DOWN</a>
</li>
<li class="class-depth-0">
<a href="global.html#ELLIPSE">ELLIPSE</a>
</li>
<li class="class-depth-0">
<a href="global.html#emit">emit</a>
</li>
<li class="class-depth-0">
<a href="global.html#EMITTER">EMITTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#GAMES">GAMES</a>
</li>
<li class="class-depth-0">
<a href="global.html#GRAPHICS">GRAPHICS</a>
</li>
<li class="class-depth-0">
<a href="global.html#GROUP">GROUP</a>
</li>
<li class="class-depth-0">
<a href="global.html#HEADLESS">HEADLESS</a>
</li>
<li class="class-depth-0">
<a href="global.html#HORIZONTAL">HORIZONTAL</a>
</li>
<li class="class-depth-0">
<a href="global.html#IMAGE">IMAGE</a>
</li>
<li class="class-depth-0">
<a href="global.html#LANDSCAPE">LANDSCAPE</a>
</li>
<li class="class-depth-0">
<a href="global.html#LEFT">LEFT</a>
</li>
<li class="class-depth-0">
<a href="global.html#LEFT_BOTTOM">LEFT_BOTTOM</a>
</li>
<li class="class-depth-0">
<a href="global.html#LEFT_CENTER">LEFT_CENTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#LEFT_TOP">LEFT_TOP</a>
</li>
<li class="class-depth-0">
<a href="global.html#LINE">LINE</a>
</li>
<li class="class-depth-0">
<a href="global.html#listeners">listeners</a>
</li>
<li class="class-depth-0">
<a href="global.html#MATRIX">MATRIX</a>
</li>
<li class="class-depth-0">
<a href="global.html#mixin">mixin</a>
</li>
<li class="class-depth-0">
<a href="global.html#NONE">NONE</a>
</li>
<li class="class-depth-0">
<a href="global.html#off">off</a>
</li>
<li class="class-depth-0">
<a href="global.html#on">on</a>
</li>
<li class="class-depth-0">
<a href="global.html#once">once</a>
</li>
<li class="class-depth-0">
<a href="global.html#PENDING_ATLAS">PENDING_ATLAS</a>
</li>
<li class="class-depth-2">
<a href="global.html#Phaser.Path#numPointsreturn%257Bnumber%257DThetotalnumberofPathPointsinthisPath.">Phaser.Path#numPoints
return {number} The total number of PathPoints in this Path.</a>
</li>
<li class="class-depth-0">
<a href="global.html#POINT">POINT</a>
</li>
<li class="class-depth-0">
<a href="global.html#POINTER">POINTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#POLYGON">POLYGON</a>
</li>
<li class="class-depth-0">
<a href="global.html#PORTRAIT">PORTRAIT</a>
</li>
<li class="class-depth-0">
<a href="global.html#RECTANGLE">RECTANGLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#removeAllListeners">removeAllListeners</a>
</li>
<li class="class-depth-0">
<a href="global.html#RENDERTEXTURE">RENDERTEXTURE</a>
</li>
<li class="class-depth-0">
<a href="global.html#RETROFONT">RETROFONT</a>
</li>
<li class="class-depth-0">
<a href="global.html#RIGHT">RIGHT</a>
</li>
<li class="class-depth-0">
<a href="global.html#RIGHT_BOTTOM">RIGHT_BOTTOM</a>
</li>
<li class="class-depth-0">
<a href="global.html#RIGHT_CENTER">RIGHT_CENTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#RIGHT_TOP">RIGHT_TOP</a>
</li>
<li class="class-depth-0">
<a href="global.html#ROPE">ROPE</a>
</li>
<li class="class-depth-0">
<a href="global.html#ROUNDEDRECTANGLE">ROUNDEDRECTANGLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#scaleModes">scaleModes</a>
</li>
<li class="class-depth-0">
<a href="global.html#SPRITE">SPRITE</a>
</li>
<li class="class-depth-0">
<a href="global.html#SPRITEBATCH">SPRITEBATCH</a>
</li>
<li class="class-depth-0">
<a href="global.html#stopImmediatePropagation">stopImmediatePropagation</a>
</li>
<li class="class-depth-0">
<a href="global.html#stopPropagation">stopPropagation</a>
</li>
<li class="class-depth-0">
<a href="global.html#TEXT">TEXT</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILEMAP">TILEMAP</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILEMAPLAYER">TILEMAPLAYER</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILESPRITE">TILESPRITE</a>
</li>
<li class="class-depth-0">
<a href="global.html#TOP_CENTER">TOP_CENTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#TOP_LEFT">TOP_LEFT</a>
</li>
<li class="class-depth-0">
<a href="global.html#TOP_RIGHT">TOP_RIGHT</a>
</li>
<li class="class-depth-0">
<a href="global.html#UP">UP</a>
</li>
<li class="class-depth-0">
<a href="global.html#VERSION">VERSION</a>
</li>
<li class="class-depth-0">
<a href="global.html#VERTICAL">VERTICAL</a>
</li>
<li class="class-depth-0">
<a href="global.html#VIDEO">VIDEO</a>
</li>
<li class="class-depth-0">
<a href="global.html#WEBGL">WEBGL</a>
</li>
<li class="class-depth-0">
<a href="global.html#WEBGL_FILTER">WEBGL_FILTER</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Core<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Game.html">Game</a></li>
<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.Cache.html">Cache</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>
<li class="class-depth-1"><a href="Phaser.Input.html">Input Manager</a></li>
<li class="class-depth-1"><a href="Phaser.ScaleManager.html">Scale Manager</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Game Objects<b class="caret"></b></a>
<ul class="dropdown-menu ">
<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>
<li class="class-depth-1"><a href="Phaser.Video.html">Video</a></li>
<li class="class-depth-1"><a href="Phaser.Particles.Arcade.Emitter.html">Particle Emitter</a></li>
<li class="class-depth-1"><a href="Phaser.Particle.html">Particle</a></li>
<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>
<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.Ellipse.html">Ellipse</a></li>
<li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li>
<li class="class-depth-1"><a href="Phaser.Matrix.html">Matrix</a></li>
<li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li>
<li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li>
<li class="class-depth-1"><a href="Phaser.Rectangle.html">Rectangle</a></li>
<li class="class-depth-1"><a href="Phaser.RoundedRectangle.html">Rounded Rectangle</a></li>
</ul>
</li>
<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-2"><a href="Phaser.Weapon.html">Weapon</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.DeviceButton.html">Device Button</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.KeyCode.html">Key Codes</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 ">
<li class="class-depth-1"><a href="http://phaser.io">Phaser Web Site</a></li>
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li>
<li class="class-depth-1"><a href="http://phaser.io/examples">Phaser Examples</a></li>
<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>
<li class="class-depth-1"><a href="http://phaser.io/learn">Tutorials</a></li>
<li class="class-depth-1"><a href="http://phaser.io/community/newsletter">Newsletter</a></li>
<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/slack">Slack</a></li>
<li class="class-depth-1"><a href="http://phaser.io/community/donate">Donate</a></li>
<li class="class-depth-1"><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<!--<h1 class="page-title">Class: ScaleManager</h1>-->
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
ScaleManager
</h2>
<div class="class-description"><p>The ScaleManager object handles the the scaling, resizing, and alignment of the<br>Game size and the game Display canvas.</p>
<p>The Game size is the logical size of the game; the Display canvas has size as an HTML element.</p>
<p>The calculations of these are heavily influenced by the bounding Parent size which is the computed<br>dimensions of the Display canvas's Parent container/element - the <em>effective CSS rules of the<br>canvas's Parent element play an important role</em> in the operation of the ScaleManager. </p>
<p>The Display canvas - or Game size, depending <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a> - is updated to best utilize the Parent size.<br>When in Fullscreen mode or with <a href="Phaser.ScaleManager.html#parentIsWindow">parentIsWindow</a> the Parent size is that of the visual viewport (see <a href="Phaser.ScaleManager.html#getParentBounds">getParentBounds</a>).</p>
<p>Parent and Display canvas containment guidelines:</p>
<ul>
<li><p>Style the Parent element (of the game canvas) to control the Parent size and<br>thus the Display canvas's size and layout.</p>
</li>
<li><p>The Parent element's CSS styles should <em>effectively</em> apply maximum (and minimum) bounding behavior.</p>
</li>
<li><p>The Parent element should <em>not</em> apply a padding as this is not accounted for.<br>If a padding is required apply it to the Parent's parent or apply a margin to the Parent.<br>If you need to add a border, margin or any other CSS around your game container, then use a parent element and<br>apply the CSS to this instead, otherwise you'll be constantly resizing the shape of the game container.</p>
</li>
<li><p>The Display canvas layout CSS styles (i.e. margins, size) should not be altered/specified as<br>they may be updated by the ScaleManager.</p>
</li>
</ul></div>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name "
id="ScaleManager"><span class="type-signature"></span>new ScaleManager<span class="signature">(game, width, height)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Create a new ScaleManager object - this is done automatically by <a href="Phaser.Game.html">Phaser.Game</a></p>
<p>The <code>width</code> and <code>height</code> constructor parameters can either be a number which represents pixels or a string that represents a percentage: e.g. <code>800</code> (for 800 pixels) or <code>&quot;80%&quot;</code> for 80%.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>game</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
</td>
<td class="description last"><p>A reference to the currently running game.</p></td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">string</span>
</td>
<td class="description last"><p>The width of the game. See above.</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">string</span>
</td>
<td class="description last"><p>The height of the game. See above.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-46">line 46</a>
</dt>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name "
id=".EXACT_FIT"><span class="type-signature">&lt;static, constant> </span>EXACT_FIT<span class="type-signature"> :integer</span></h4>
</dt>
<dd>
<div class="description">
<p>A scale mode that stretches content to fill all available space - see <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-609">line 609</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id=".NO_SCALE"><span class="type-signature">&lt;static, constant> </span>NO_SCALE<span class="type-signature"> :integer</span></h4>
</dt>
<dd>
<div class="description">
<p>A scale mode that prevents any scaling - see <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-617">line 617</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id=".RESIZE"><span class="type-signature">&lt;static, constant> </span>RESIZE<span class="type-signature"> :integer</span></h4>
</dt>
<dd>
<div class="description">
<p>A scale mode that causes the Game size to change - see <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-633">line 633</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id=".SHOW_ALL"><span class="type-signature">&lt;static, constant> </span>SHOW_ALL<span class="type-signature"> :integer</span></h4>
</dt>
<dd>
<div class="description">
<p>A scale mode that shows the entire game while maintaining proportions - see <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-625">line 625</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id=".USER_SCALE"><span class="type-signature">&lt;static, constant> </span>USER_SCALE<span class="type-signature"> :integer</span></h4>
</dt>
<dd>
<div class="description">
<p>A scale mode that allows a custom scale factor - see <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-641">line 641</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="aspectRatio"><span class="type-signature">&lt;readonly> </span>aspectRatio<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The aspect ratio of the scaled Display canvas.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-349">line 349</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="boundingParent"><span class="type-signature">&lt;readonly> </span>boundingParent<span class="type-signature"> :DOMElement</span></h4>
</dt>
<dd>
<div class="description">
<p>The DOM element that is considered the Parent bounding element, if any.</p>
<p>This <code>null</code> if <a href="Phaser.ScaleManager.html#parentIsWindow">parentIsWindow</a> is true or if fullscreen mode is entered and <a href="Phaser.ScaleManager.html#fullScreenTarget">fullScreenTarget</a> is specified.<br>It will also be null if there is no game canvas or if the game canvas has no parent.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-2091">line 2091</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="bounds"><span class="type-signature">&lt;readonly> </span>bounds<span class="type-signature"> :<a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span></h4>
</dt>
<dd>
<div class="description">
<p>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.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-342">line 342</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="compatibility"><span class="type-signature">&lt;internal> </span>compatibility<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Various compatibility settings.<br>A value of &quot;(auto)&quot; indicates the setting is configured based on device and runtime information.</p>
<p>A <a href="Phaser.ScaleManager.html#refresh">refresh</a> may need to be performed after making changes.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>supportsFullScreen</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
(auto)
</td>
<td class="description last"><p>True only if fullscreen support will be used. (Changing to fullscreen still might not work.)</p></td>
</tr>
<tr>
<td class="name"><code>orientationFallback</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
(auto)
</td>
<td class="description last"><p>See <a href="Phaser.DOM.html#.getScreenOrientation">Phaser.DOM.getScreenOrientation</a>.</p></td>
</tr>
<tr>
<td class="name"><code>noMargins</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>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.</p></td>
</tr>
<tr>
<td class="name"><code>scrollTo</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
</td>
<td class="attributes">
&lt;optional><br>
&lt;nullable><br>
</td>
<td class="default">
(auto)
</td>
<td class="description last"><p>If specified the window will be scrolled to this position on every refresh.</p></td>
</tr>
<tr>
<td class="name"><code>forceMinimumDocumentHeight</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If enabled the document elements minimum height is explicitly set on updates.<br> The height set varies by device and may either be the height of the window or the viewport.</p></td>
</tr>
<tr>
<td class="name"><code>canExpandParent</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>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.</p></td>
</tr>
<tr>
<td class="name"><code>clickTrampoline</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
(auto)
</td>
<td class="description last"><p>On certain browsers (eg. IE) FullScreen events need to be triggered via 'click' events.<br> A value of 'when-not-mouse' uses a click trampoline when a pointer that is not the primary mouse is used.<br> Any other string value (including the empty string) prevents using click trampolines.<br> For more details on click trampolines see <a href="Phaser.Pointer.html#addClickTrampoline">Phaser.Pointer#addClickTrampoline</a>.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-410">line 410</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="currentScaleMode"><span class="type-signature">&lt;internal, readonly> </span>currentScaleMode<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the current scale mode - for normal or fullscreen operation.</p>
<p>See <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a> for the different modes allowed.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-2224">line 2224</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="dom"><span class="type-signature">&lt;internal, readonly> </span>dom<span class="type-signature"> :<a href="Phaser.DOM.html">Phaser.DOM</a></span></h4>
</dt>
<dd>
<div class="description">
<p>Provides access to some cross-device DOM functions.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-62">line 62</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="enterIncorrectOrientation"><span class="type-signature"></span>enterIncorrectOrientation<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
<div class="description">
<p>This signal is dispatched when the browser enters an incorrect orientation, as defined by <a href="Phaser.ScaleManager.html#forceOrientation">forceOrientation</a>.</p>
<p>This is signaled from <code>preUpdate</code> (or <code>pauseUpdate</code>) <em>even when</em> the game is paused.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-211">line 211</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="forceLandscape"><span class="type-signature">&lt;internal, readonly> </span>forceLandscape<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>If true, the game should only run in a landscape orientation.<br>Change with <a href="Phaser.ScaleManager.html#forceOrientation">forceOrientation</a>.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-140">line 140</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="forcePortrait"><span class="type-signature">&lt;internal, readonly> </span>forcePortrait<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>If true, the game should only run in a portrait<br>Change with <a href="Phaser.ScaleManager.html#forceOrientation">forceOrientation</a>.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-150">line 150</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="fullScreenScaleMode"><span class="type-signature"></span>fullScreenScaleMode<span class="type-signature"> :integer</span></h4>
</dt>
<dd>
<div class="description">
<p>The scaling method used by the ScaleManager when in fullscreen.</p>
<p>See <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a> for the different modes allowed.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-2183">line 2183</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="fullScreenTarget"><span class="type-signature"></span>fullScreenTarget<span class="type-signature"> :DOMElement</span></h4>
</dt>
<dd>
<div class="description">
<p>If specified, this is the DOM element on which the Fullscreen API enter request will be invoked.<br>The target element must have the correct CSS styling and contain the Display canvas.</p>
<p>The elements style will be modified (ie. the width and height might be set to 100%)<br>but it will not be added to, removed from, or repositioned within the DOM.<br>An attempt is made to restore relevant style changes when fullscreen mode is left.</p>
<p>For pre-2.2.0 behavior set <code>game.scale.fullScreenTarget = game.canvas</code>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-248">line 248</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="game"><span class="type-signature">&lt;internal, readonly> </span>game<span class="type-signature"> :<a href="Phaser.Game.html">Phaser.Game</a></span></h4>
</dt>
<dd>
<div class="description">
<p>A reference to the currently running game.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-54">line 54</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="grid"><span class="type-signature"></span>grid<span class="type-signature"> :<a href="Phaser.FlexGrid.html">Phaser.FlexGrid</a></span></h4>
</dt>
<dd>
<div class="description">
<p><em>EXPERIMENTAL:</em> A responsive grid on which you can align game objects.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-69">line 69</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="hasPhaserSetFullScreen"><span class="type-signature"></span>hasPhaserSetFullScreen<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>This boolean provides you with a way to determine if the browser is in Full Screen<br>mode (via the Full Screen API), and Phaser was the one responsible for activating it.</p>
<p>It's possible that ScaleManager.isFullScreen returns <code>true</code> even if Phaser wasn't the<br>one that made the browser go full-screen, so this flag lets you determine that.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-233">line 233</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="height"><span class="type-signature">&lt;readonly> </span>height<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>Target height (in pixels) of the Display canvas.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-83">line 83</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="incorrectOrientation"><span class="type-signature">&lt;internal, readonly> </span>incorrectOrientation<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>True if <a href="Phaser.ScaleManager.html#forceLandscape">forceLandscape</a> or <a href="Phaser.ScaleManager.html#forcePortrait">forcePortrait</a> are set and do not agree with the browser orientation.</p>
<p>This value is not updated immediately.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-161">line 161</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="isFullScreen"><span class="type-signature">&lt;readonly> </span>isFullScreen<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns true if the browser is in fullscreen mode, otherwise false.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-2315">line 2315</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="isGameLandscape"><span class="type-signature">&lt;readonly> </span>isGameLandscape<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns true if the game dimensions are landscape (width &gt; height).<br>This is especially useful to check when using the RESIZE scale mode<br>but wanting to maintain game orientation on desktop browsers,<br>where typically the screen orientation will always be landscape regardless of the browser viewport.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-2380">line 2380</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="isGamePortrait"><span class="type-signature">&lt;readonly> </span>isGamePortrait<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns true if the game dimensions are portrait (height &gt; width).<br>This is especially useful to check when using the RESIZE scale mode<br>but wanting to maintain game orientation on desktop browsers,<br>where typically the screen orientation will always be landscape regardless of the browser viewport.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-2362">line 2362</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="isLandscape"><span class="type-signature">&lt;readonly> </span>isLandscape<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns true if the screen orientation is in landscape mode.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-2347">line 2347</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="isPortrait"><span class="type-signature">&lt;readonly> </span>isPortrait<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns true if the screen orientation is in portrait mode.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-2332">line 2332</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="leaveIncorrectOrientation"><span class="type-signature"></span>leaveIncorrectOrientation<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
<div class="description">
<p>This signal is dispatched when the browser leaves an incorrect orientation, as defined by <a href="Phaser.ScaleManager.html#forceOrientation">forceOrientation</a>.</p>
<p>This is signaled from <code>preUpdate</code> (or <code>pauseUpdate</code>) <em>even when</em> the game is paused.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-221">line 221</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="margin"><span class="type-signature">&lt;internal, readonly> </span>margin<span class="type-signature"> :Bounds-like</span></h4>
</dt>
<dd>
<div class="description">
<p>The Display canvas is aligned by adjusting the margins; the last margins are stored here.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Bounds-like</span>
</li>
</ul>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-335">line 335</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="maxHeight"><span class="type-signature">&lt;internal, readonly> </span>maxHeight<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>Maximum height the canvas should be scaled to (in pixels).<br>If null it will scale to whatever height the browser can handle.<br>Change with <a href="Phaser.ScaleManager.html#setMinMax">setMinMax</a>.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-121">line 121</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="maxWidth"><span class="type-signature">&lt;internal, readonly> </span>maxWidth<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>Maximum width the canvas should be scaled to (in pixels).<br>If null it will scale to whatever width the browser can handle.<br>Change with <a href="Phaser.ScaleManager.html#setMinMax">setMinMax</a>.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-102">line 102</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="minHeight"><span class="type-signature">&lt;internal, readonly> </span>minHeight<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>Minimum height the canvas should be scaled to (in pixels).<br>Change with <a href="Phaser.ScaleManager.html#setMinMax">setMinMax</a>.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-111">line 111</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="minWidth"><span class="type-signature">&lt;internal, readonly> </span>minWidth<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>Minimum width the canvas should be scaled to (in pixels).<br>Change with <a href="Phaser.ScaleManager.html#setMinMax">setMinMax</a>.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-92">line 92</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="offset"><span class="type-signature">&lt;internal, readonly> </span>offset<span class="type-signature"> :<a href="Phaser.Point.html">Phaser.Point</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The offset coordinates of the Display canvas from the top-left of the browser window.<br>The is used internally by Phaser.Pointer (for Input) and possibly other types.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-130">line 130</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="onFullScreenChange"><span class="type-signature"></span>onFullScreenChange<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
<div class="description">
<p>This signal is dispatched when the browser enters or leaves fullscreen mode, if supported.</p>
<p>The signal is supplied with a single argument: <code>scale</code> (the ScaleManager). Use <code>scale.isFullScreen</code> to determine<br>if currently running in Fullscreen mode.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-290">line 290</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="onFullScreenError"><span class="type-signature"></span>onFullScreenError<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
<div class="description">
<p>This signal is dispatched when the browser fails to enter fullscreen mode;<br>or if the device does not support fullscreen mode and <code>startFullScreen</code> is invoked.</p>
<p>The signal is supplied with a single argument: <code>scale</code> (the ScaleManager).</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-301">line 301</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="onFullScreenInit"><span class="type-signature"></span>onFullScreenInit<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
<div class="description">
<p>This signal is dispatched when fullscreen mode is ready to be initialized but<br>before the fullscreen request.</p>
<p>The signal is passed two arguments: <code>scale</code> (the ScaleManager), and an object in the form <code>{targetElement: DOMElement}</code>.</p>
<p>The <code>targetElement</code> is the <a href="Phaser.ScaleManager.html#fullScreenTarget">fullScreenTarget</a> element,<br>if such is assigned, or a new element created by <a href="Phaser.ScaleManager.html#createFullScreenTarget">createFullScreenTarget</a>.</p>
<p>Custom CSS styling or resets can be applied to <code>targetElement</code> as required.</p>
<p>If <code>targetElement</code> is <em>not</em> the same element as <a href="Phaser.ScaleManager.html#fullScreenTarget">fullScreenTarget</a>:</p>
<ul>
<li>After initialization the Display canvas is moved onto the <code>targetElement</code> for<br>the duration of the fullscreen mode, and restored to it's original DOM location when fullscreen is exited.</li>
<li>The <code>targetElement</code> is moved/re-parented within the DOM and may have its CSS styles updated.</li>
</ul>
<p>The behavior of a pre-assigned target element is covered in <a href="Phaser.ScaleManager.html#fullScreenTarget">fullScreenTarget</a>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-279">line 279</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="onOrientationChange"><span class="type-signature"></span>onOrientationChange<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
<div class="description">
<p>This signal is dispatched when the orientation changes <em>or</em> the validity of the current orientation changes.</p>
<p>The signal is supplied with the following arguments:</p>
<ul>
<li><code>scale</code> - the ScaleManager object</li>
<li><code>prevOrientation</code>, a string - The previous orientation as per <a href="Phaser.ScaleManager.html#screenOrientation">screenOrientation</a>.</li>
<li><code>wasIncorrect</code>, a boolean - True if the previous orientation was last determined to be incorrect.</li>
</ul>
<p>Access the current orientation and validity with <code>scale.screenOrientation</code> and <code>scale.incorrectOrientation</code>.<br>Thus the following tests can be done:</p>
<pre class="prettyprint source"><code>// The orientation itself changed:
scale.screenOrientation !== prevOrientation
// The orientation just became incorrect:
scale.incorrectOrientation && !wasIncorrect</code></pre><p>It is possible that this signal is triggered after <a href="Phaser.ScaleManager.html#forceOrientation">forceOrientation</a> so the orientation<br>correctness changes even if the orientation itself does not change.</p>
<p>This is signaled from <code>preUpdate</code> (or <code>pauseUpdate</code>) <em>even when</em> the game is paused.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-201">line 201</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="onSizeChange"><span class="type-signature"></span>onSizeChange<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
<div class="description">
<p>This signal is dispatched when the size of the Display canvas changes <em>or</em> the size of the Game changes.<br>When invoked this is done <em>after</em> the Canvas size/position have been updated.</p>
<p>This signal is <em>only</em> called when a change occurs and a reflow may be required.<br>For example, if the canvas does not change sizes because of CSS settings (such as min-width)<br>then this signal will <em>not</em> be triggered.</p>
<p>Use this to handle responsive game layout options.</p>
<p>This is signaled from <code>preUpdate</code> (or <code>pauseUpdate</code>) <em>even when</em> the game is paused.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-487">line 487</a>
</dt>
<dt class="tag-todo">To Do:</dt>
<dd class="tag-todo">
<ul>
<li>Formalize the arguments, if any, supplied to this signal.</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name "
id="pageAlignHorizontally"><span class="type-signature"></span>pageAlignHorizontally<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>When enabled the Display canvas will be horizontally-aligned <em>in the Parent container</em> (or <a href="Phaser.ScaleManager.html#parentIsWindow">window</a>).</p>
<p>To align horizontally across the page the Display canvas should be added directly to page;<br>or the parent container should itself be horizontally aligned.</p>
<p>Horizontal alignment is not applicable with the <a href="Phaser.ScaleManager.html#.RESIZE">RESIZE</a> scaling mode.</p>
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-2244">line 2244</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="pageAlignVertically"><span class="type-signature"></span>pageAlignVertically<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>When enabled the Display canvas will be vertically-aligned <em>in the Parent container</em> (or <a href="Phaser.ScaleManager.html#parentIsWindow">window</a>).</p>
<p>To align vertically the Parent element should have a <em>non-collapsible</em> height, such that it will maintain<br>a height <em>larger</em> than the height of the contained Game canvas - the game canvas will then be scaled vertically<br><em>within</em> the remaining available height dictated by the Parent element.</p>
<p>One way to prevent the parent from collapsing is to add an absolute &quot;min-height&quot; CSS property to the parent element.<br>If specifying a relative &quot;min-height/height&quot; or adjusting margins, the Parent height must still be non-collapsible (see note).</p>
<p><em>Note</em>: In version 2.2 the minimum document height is <em>not</em> automatically set to the viewport/window height.<br>To automatically update the minimum document height set <a href="Phaser.ScaleManager.html#compatibility">compatibility.forceMinimumDocumentHeight</a> to true.</p>
<p>Vertical alignment is not applicable with the <a href="Phaser.ScaleManager.html#.RESIZE">RESIZE</a> scaling mode.</p>
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-2276">line 2276</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="parentIsWindow"><span class="type-signature"></span>parentIsWindow<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>If the parent container of the Game canvas is the browser window itself (i.e. document.body),<br>rather than another div, this should set to <code>true</code>.</p>
<p>The <a href="Phaser.ScaleManager.html#parentNode">parentNode</a> property is generally ignored while this is in effect.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-442">line 442</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="parentNode"><span class="type-signature"></span>parentNode<span class="type-signature"> :DOMElement</span></h4>
</dt>
<dd>
<div class="description">
<p>The <em>original</em> DOM element for the parent of the Display canvas.<br>This may be different in fullscreen - see <a href="Phaser.ScaleManager.html#createFullScreenTarget">createFullScreenTarget</a>.</p>
<p>This should only be changed after moving the Game canvas to a different DOM parent.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-452">line 452</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="parentScaleFactor"><span class="type-signature">&lt;readonly> </span>parentScaleFactor<span class="type-signature"> :<a href="Phaser.Point.html">Phaser.Point</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The scale of the game in relation to its parent container.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-459">line 459</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="scaleFactor"><span class="type-signature">&lt;readonly> </span>scaleFactor<span class="type-signature"> :<a href="Phaser.Point.html">Phaser.Point</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The <em>current</em> scale factor based on the game dimensions vs. the scaled dimensions.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-318">line 318</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="scaleFactorInversed"><span class="type-signature">&lt;internal, readonly> </span>scaleFactorInversed<span class="type-signature"> :<a href="Phaser.Point.html">Phaser.Point</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The <em>current</em> inversed scale factor. The displayed dimensions divided by the game dimensions.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-326">line 326</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="scaleMode"><span class="type-signature"></span>scaleMode<span class="type-signature"> :integer</span></h4>
</dt>
<dd>
<div class="description">
<p>The scaling method used by the ScaleManager when not in fullscreen.</p>
<dl><br> <dt><a href="Phaser.ScaleManager.html#.NO_SCALE">Phaser.ScaleManager.NO_SCALE</a></dt><br> <dd><br> The Game display area will not be scaled - even if it is too large for the canvas/screen.<br> This mode <em>ignores</em> any applied scaling factor and displays the canvas at the Game size.<br> </dd><br> <dt><a href="Phaser.ScaleManager.html#.EXACT_FIT">Phaser.ScaleManager.EXACT_FIT</a></dt><br> <dd><br> The Game display area will be <em>stretched</em> to fill the entire size of the canvas's parent element and/or screen.<br> Proportions are not maintained.<br> </dd><br> <dt><a href="Phaser.ScaleManager.html#.SHOW_ALL">Phaser.ScaleManager.SHOW_ALL</a></dt><br> <dd><br> Show the entire game display area while <em>maintaining</em> the original aspect ratio.<br> </dd><br> <dt><a href="Phaser.ScaleManager.html#.RESIZE">Phaser.ScaleManager.RESIZE</a></dt><br> <dd><br> The dimensions of the game display area are changed to match the size of the parent container.<br> That is, this mode <em>changes the Game size</em> to match the display size.<br> <p><br> Any manually set Game size (see <a href="Phaser.ScaleManager.html#setGameSize">setGameSize</a>) is ignored while in effect.<br> </dd><br> <dt><a href="Phaser.ScaleManager.html#.USER_SCALE">Phaser.ScaleManager.USER_SCALE</a></dt><br> <dd><br> The game Display is scaled according to the user-specified scale set by <a href="Phaser.ScaleManager.html#setUserScale">setUserScale</a>.<br> <p><br> This scale can be adjusted in the <a href="Phaser.ScaleManager.html#setResizeCallback">resize callback</a><br> for flexible custom-sizing needs.<br> </dd><br></dl>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-2119">line 2119</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="screenOrientation"><span class="type-signature">&lt;readonly> </span>screenOrientation<span class="type-signature"> :string</span></h4>
</dt>
<dd>
<div class="description">
<p>The <em>last known</em> orientation of the screen, as defined in the Window Screen Web API.<br>See <a href="Phaser.DOM.html#.getScreenOrientation">Phaser.DOM.getScreenOrientation</a> for possible values.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-311">line 311</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="sourceAspectRatio"><span class="type-signature">&lt;readonly> </span>sourceAspectRatio<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The aspect ratio of the original game dimensions.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-356">line 356</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="trackParentInterval"><span class="type-signature">&lt;internal> </span>trackParentInterval<span class="type-signature"> :integer</span></h4>
</dt>
<dd>
<div class="description">
<p>The maximum time (in ms) between dimension update checks for the Canvas's parent element (or window).<br>Update checks normally happen quicker in response to other events.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>2000</li></ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-470">line 470</a>
</dt>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="Phaser.ScaleManager.html#refresh">refresh</a></li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name "
id="width"><span class="type-signature">&lt;readonly> </span>width<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>Target width (in pixels) of the Display canvas.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-76">line 76</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="windowConstraints"><span class="type-signature"></span>windowConstraints<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The edges on which to constrain the game Display/canvas in <em>addition</em> to the restrictions of the parent container.</p>
<p>The properties are strings and can be '', 'visual', 'layout', or 'layout-soft'.</p>
<ul>
<li>If 'visual', the edge will be constrained to the Window / displayed screen area</li>
<li>If 'layout', the edge will be constrained to the CSS Layout bounds</li>
<li>An invalid value is treated as 'visual'</li>
</ul>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>bottom</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>{"right":"layout","bottom":""}</li></ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-379">line 379</a>
</dt>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name "
id="boot"><span class="type-signature">&lt;internal> </span>boot<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Start the ScaleManager.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-645">line 645</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="createFullScreenTarget"><span class="type-signature">&lt;internal> </span>createFullScreenTarget<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Creates a fullscreen target. This is called automatically as as needed when entering<br>fullscreen mode and the resulting element is supplied to <a href="Phaser.ScaleManager.html#onFullScreenInit">onFullScreenInit</a>.</p>
<p>Use <a href="Phaser.ScaleManager.html#onFullScreenInit">onFullScreenInit</a> to customize the created object.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-1728">line 1728</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="destroy"><span class="type-signature">&lt;internal> </span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Destroys the ScaleManager and removes any event listeners.<br>This should probably only be called when the game is destroyed.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-2058">line 2058</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="forceOrientation"><span class="type-signature"></span>forceOrientation<span class="signature">(forceLandscape, <span class="optional">forcePortrait</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Force the game to run in only one orientation.</p>
<p>This enables generation of incorrect orientation signals and affects resizing but does not otherwise rotate or lock the orientation.</p>
<p>Orientation checks are performed via the Screen Orientation API, if available in browser. This means it will check your monitor<br>orientation on desktop, or your device orientation on mobile, rather than comparing actual game dimensions. If you need to check the<br>viewport dimensions instead and bypass the Screen Orientation API then set: <code>ScaleManager.compatibility.orientationFallback = 'viewport'</code></p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>forceLandscape</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>true if the game should run in landscape mode only.</p></td>
</tr>
<tr>
<td class="name"><code>forcePortrait</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>true if the game should run in portrait mode only.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-1163">line 1163</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getParentBounds"><span class="type-signature">&lt;internal> </span>getParentBounds<span class="signature">(<span class="optional">target</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Rectangle.html">Phaser.Rectangle</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the computed Parent size/bounds that the Display canvas is allowed/expected to fill.</p>
<p>If in fullscreen mode or without parent (see <a href="Phaser.ScaleManager.html#parentIsWindow">parentIsWindow</a>),<br>this will be the bounds of the visual viewport itself.</p>
<p>This function takes the <a href="Phaser.ScaleManager.html#windowConstraints">windowConstraints</a> into consideration - if the parent is partially outside<br>the viewport then this function may return a smaller than expected size.</p>
<p>Values are rounded to the nearest pixel.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
(new Rectangle)
</td>
<td class="description last"><p>The rectangle to update; a new one is created as needed.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The established parent bounds.</p>
</div>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-1408">line 1408</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="parseConfig"><span class="type-signature">&lt;internal> </span>parseConfig<span class="signature">(config)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Load configuration settings.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The game configuration object.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-748">line 748</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="preUpdate"><span class="type-signature">&lt;internal> </span>preUpdate<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The ScaleManager.preUpdate is called automatically by the core Game loop.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-1028">line 1028</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="refresh"><span class="type-signature"></span>refresh<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The &quot;refresh&quot; methods informs the ScaleManager that a layout refresh is required.</p>
<p>The ScaleManager automatically queues a layout refresh (eg. updates the Game size or Display canvas layout)<br>when the browser is resized, the orientation changes, or when there is a detected change<br>of the Parent size. Refreshing is also done automatically when public properties,<br>such as <a href="Phaser.ScaleManager.html#scaleMode">scaleMode</a>, are updated or state-changing methods are invoked.</p>
<p>The &quot;refresh&quot; method <em>may</em> need to be used in a few (rare) situtations when</p>
<ul>
<li>a device change event is not correctly detected; or</li>
<li>the Parent size changes (and an immediate reflow is desired); or</li>
<li>the ScaleManager state is updated by non-standard means; or</li>
<li>certain <a href="Phaser.ScaleManager.html#compatibility">compatibility</a> properties are manually changed.</li>
</ul>
<p>The queued layout refresh is not immediate but will run promptly in an upcoming <code>preRender</code>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-1301">line 1301</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="scaleSprite"><span class="type-signature">&lt;internal> </span>scaleSprite<span class="signature">(sprite, <span class="optional">width</span>, <span class="optional">height</span>, <span class="optional">letterBox</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Sprite.html">Phaser.Sprite</a>|<a href="Phaser.Image.html">Phaser.Image</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Takes a Sprite or Image object and scales it to fit the given dimensions.<br>Scaling happens proportionally without distortion to the sprites texture.<br>The letterBox parameter controls if scaling will produce a letter-box effect or zoom the<br>sprite until it fills the given values. Note that with letterBox set to false the scaled sprite may spill out over either<br>the horizontal or vertical sides of the target dimensions. If you wish to stop this you can crop the Sprite.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sprite</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|
<span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The sprite we want to scale.</p></td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>The target width that we want to fit the sprite in to. If not given it defaults to ScaleManager.width.</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>The target height that we want to fit the sprite in to. If not given it defaults to ScaleManager.height.</p></td>
</tr>
<tr>
<td class="name"><code>letterBox</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>True if we want the <code>fitted</code> mode. Otherwise, the function uses the <code>zoom</code> mode.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|
<span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The scaled sprite.</p>
</div>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-1988">line 1988</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="setGameSize"><span class="type-signature"></span>setGameSize<span class="signature">(width, height)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Set the actual Game size.<br>Use this instead of directly changing <code>game.width</code> or <code>game.height</code>.</p>
<p>The actual physical display (Canvas element size) depends on various settings including</p>
<ul>
<li>Scale mode</li>
<li>Scaling factor</li>
<li>Size of Canvas's parent element or CSS rules such as min-height/max-height;</li>
<li>The size of the Window</li>
</ul>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="description last"><p><em>Game width</em>, in pixels.</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="description last"><p><em>Game height</em>, in pixels.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-881">line 881</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="setMinMax"><span class="type-signature"></span>setMinMax<span class="signature">(minWidth, minHeight, <span class="optional">maxWidth</span>, <span class="optional">maxHeight</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Set the min and max dimensions for the Display canvas.</p>
<p><em>Note:</em> The min/max dimensions are only applied in some cases</p>
<ul>
<li>When the device is not in an incorrect orientation; or</li>
<li>The scale mode is EXACT_FIT when not in fullscreen</li>
</ul>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>minWidth</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The minimum width the game is allowed to scale down to.</p></td>
</tr>
<tr>
<td class="name"><code>minHeight</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The minimum height the game is allowed to scale down to.</p></td>
</tr>
<tr>
<td class="name"><code>maxWidth</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The maximum width the game is allowed to scale up to; only changed if specified.</p></td>
</tr>
<tr>
<td class="name"><code>maxHeight</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The maximum height the game is allowed to scale up to; only changed if specified.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-996">line 996</a>
</dt>
<dt class="tag-todo">To Do:</dt>
<dd class="tag-todo">
<ul>
<li>These values are only sometimes honored.</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name "
id="setResizeCallback"><span class="type-signature"></span>setResizeCallback<span class="signature">(callback, context)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Sets the callback that will be invoked before sizing calculations.</p>
<p>This is the appropriate place to call <a href="Phaser.ScaleManager.html#setUserScale">setUserScale</a> if needing custom dynamic scaling.</p>
<p>The callback is supplied with two arguments <code>scale</code> and <code>parentBounds</code> where <code>scale</code> is the ScaleManager<br>and <code>parentBounds</code>, a Phaser.Rectangle, is the size of the Parent element.</p>
<p>This callback</p>
<ul>
<li>May be invoked even though the parent container or canvas sizes have not changed</li>
<li>Unlike <a href="Phaser.ScaleManager.html#onSizeChange">onSizeChange</a>, it runs <em>before</em> the canvas is guaranteed to be updated</li>
<li>Will be invoked from <code>preUpdate</code>, <em>even when</em> the game is paused </li>
</ul>
<p>See <a href="Phaser.ScaleManager.html#onSizeChange">onSizeChange</a> for a better way of reacting to layout updates.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>The callback that will be called each time a window.resize event happens or if set, the parent container resizes.</p></td>
</tr>
<tr>
<td class="name"><code>context</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The context in which the callback will be called.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-933">line 933</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="setupScale"><span class="type-signature">&lt;internal> </span>setupScale<span class="signature">(width, height)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Calculates and sets the game dimensions based on the given width and height.</p>
<p>This should <em>not</em> be called when in fullscreen mode.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">string</span>
</td>
<td class="description last"><p>The width of the game.</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">string</span>
</td>
<td class="description last"><p>The height of the game.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-781">line 781</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="setUserScale"><span class="type-signature"></span>setUserScale<span class="signature">(hScale, vScale, <span class="optional">hTrim</span>, <span class="optional">vTrim</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Set a User scaling factor used in the USER_SCALE scaling mode.</p>
<p>The target canvas size is computed by:</p>
<pre class="prettyprint source"><code>canvas.width = (game.width * hScale) - hTrim
canvas.height = (game.height * vScale) - vTrim</code></pre><p>This method can be used in the <a href="Phaser.ScaleManager.html#setResizeCallback">resize callback</a>.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hScale</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Horizontal scaling factor.</p></td>
</tr>
<tr>
<td class="name"><code>vScale</code></td>
<td class="type">
<span class="param-type">numer</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Vertical scaling factor.</p></td>
</tr>
<tr>
<td class="name"><code>hTrim</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>Horizontal trim, applied after scaling.</p></td>
</tr>
<tr>
<td class="name"><code>vTrim</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>Vertical trim, applied after scaling.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-909">line 909</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="startFullScreen"><span class="type-signature"></span>startFullScreen<span class="signature">(<span class="optional">antialias</span>, <span class="optional">allowTrampoline</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Start the browsers fullscreen mode - this <em>must</em> be called from a user input Pointer or Mouse event.</p>
<p>The Fullscreen API must be supported by the browser for this to work - it is not the same as setting<br>the game size to fill the browser window. See <a href="Phaser.ScaleManager.html#compatibility">compatibility.supportsFullScreen</a> to check if the current<br>device is reported to support fullscreen mode.</p>
<p>The fullScreenFailed signal will be dispatched if the fullscreen change request failed or the game does not support the Fullscreen API.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>antialias</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>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.</p></td>
</tr>
<tr>
<td class="name"><code>allowTrampoline</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>Internal argument. If <code>false</code> click trampolining is suppressed.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>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.)</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-1749">line 1749</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="stopFullScreen"><span class="type-signature"></span>stopFullScreen<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Stops / exits fullscreen mode, if active.</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>Returns true if the browser supports fullscreen mode and fullscreen mode will be exited.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_ScaleManager.js.html">core/ScaleManager.js</a>, <a href="src_core_ScaleManager.js.html#sunlight-1-line-1842">line 1842</a>
</dt>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Phaser Copyright © 2012-2016 Photon Storm Ltd.
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
on Fri Aug 26 2016 01:16:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</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( {
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
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>
Reference in a new issue View git blame Copy permalink