phaser/docs/Phaser.ScaleManager.html

6968 lines
94 KiB
HTML
Raw Normal View History

2013-10-03 00:21:08 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: ScaleManager</title>
2013-10-03 00:21:08 +00:00
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser</a>
<ul class="nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
2013-10-03 00:21:08 +00:00
class="caret"></b></a>
<ul class="dropdown-menu ">
2014-04-10 22:13:43 +00:00
<li class="class-depth-0">
<a href="Phaser.html">Phaser</a>
2013-10-03 00:21:08 +00:00
</li>
</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 ">
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Animation.html">Animation</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.AnimationManager.html">AnimationManager</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-29 14:39:02 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Button.html">Button</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Device.html">Device</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Easing.html">Easing</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Back.html">Back</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Events.html">Events</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Filter.html">Filter</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-1">
<a href="Phaser.FlexGrid.html">FlexGrid</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexLayer.html">FlexLayer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Game.html">Game</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.GamepadButton.html">GamepadButton</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Graphics.html">Graphics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Group.html">Group</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Input.html">Input</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Key.html">Key</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Line.html">Line</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Loader.html">Loader</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.LoaderParser.html">LoaderParser</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Math.html">Math</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Mouse.html">Mouse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Net.html">Net</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Particles.html">Particles</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.html">Physics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Plugin.html">Plugin</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Point.html">Point</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Pointer.html">Pointer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Sound.html">Sound</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Sprite.html">Sprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Stage.html">Stage</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.State.html">State</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.StateManager.html">StateManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Text.html">Text</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tile.html">Tile</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tileset.html">Tileset</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Time.html">Time</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Timer.html">Timer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Touch.html">Touch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.World.html">World</a>
</li>
</ul>
</li>
2014-09-09 14:36:56 +00:00
2013-10-03 00:21:08 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Class: ScaleManager</h1>
2013-10-03 00:21:08 +00:00
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
ScaleManager
2013-10-03 00:21:08 +00:00
</h2>
<div class="class-description"><p>Phaser.ScaleManager</p></div>
2013-10-03 00:21:08 +00:00
</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>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<div class="description">
<p>The ScaleManager object is responsible for helping you manage the scaling, resizing and alignment of your game within the browser.</p>
2013-10-03 00:21:08 +00:00
</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>
2014-09-09 14:36:56 +00:00
|
<span class="param-type">string</span>
2013-10-03 00:21:08 +00:00
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>The width of the game.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
2014-09-09 14:36:56 +00:00
|
<span class="param-type">string</span>
2013-10-03 00:21:08 +00:00
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>The height of the game.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-16">line 16</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</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"> :number</span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-289">line 289</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="NO_SCALE"><span class="type-signature">&lt;static, constant> </span>NO_SCALE<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-295">line 295</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="RESIZE"><span class="type-signature">&lt;static, constant> </span>RESIZE<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-307">line 307</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="SHOW_ALL"><span class="type-signature">&lt;static, constant> </span>SHOW_ALL<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-301">line 301</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="aspectRatio"><span class="type-signature">&lt;readonly> </span>aspectRatio<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>aspectRatio</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The aspect ratio of the scaled game.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
2014-05-20 09:12:48 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-186">line 186</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="bounds"><span class="type-signature">&lt;readonly> </span>bounds<span class="type-signature"></span></h4>
</dt>
<dd>
<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>bounds</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>
</td>
<td class="description last"><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></td>
</tr>
</tbody>
</table>
</dl>
2013-10-03 00:21:08 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-180">line 180</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="enterFullScreen"><span class="type-signature"></span>enterFullScreen<span class="type-signature"></span></h4>
</dt>
<dd>
<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>enterFullScreen</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>
</td>
<td class="description last"><p>The event that is dispatched when the browser enters full screen mode (if it supports the FullScreen API).</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-134">line 134</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="enterIncorrectOrientation"><span class="type-signature"></span>enterIncorrectOrientation<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>enterIncorrectOrientation</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>
2013-10-03 00:21:08 +00:00
</td>
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The event that is dispatched when the browser enters an incorrect orientation, as defined by forceOrientation.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-116">line 116</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="enterLandscape"><span class="type-signature"></span>enterLandscape<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>enterLandscape</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>
2013-10-03 00:21:08 +00:00
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>The event that is dispatched when the browser enters landscape orientation having been in portrait.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-106">line 106</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="enterPortrait"><span class="type-signature"></span>enterPortrait<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>enterPortrait</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>
2013-10-03 00:21:08 +00:00
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>The event that is dispatched when the browser enters portrait orientation having been in landscape.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-111">line 111</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="event"><span class="type-signature"></span>event<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>event-</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type">any</span>
2013-10-03 00:21:08 +00:00
</td>
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The native browser events from full screen API changes.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-197">line 197</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="forceLandscape"><span class="type-signature"></span>forceLandscape<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>forceLandscape</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type">boolean</span>
2013-10-03 00:21:08 +00:00
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>Set to <code>true</code> if the game should only run in a landscape orientation.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
2013-11-28 15:57:09 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
2013-10-03 00:21:08 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-67">line 67</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="forcePortrait"><span class="type-signature"></span>forcePortrait<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>forcePortrait</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type">boolean</span>
2013-10-03 00:21:08 +00:00
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>Set to <code>true</code> if the game should only run in a portrait orientation.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
2013-11-28 15:57:09 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
2013-10-03 00:21:08 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-73">line 73</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="fullScreenTarget"><span class="type-signature"></span>fullScreenTarget<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This is the DOM element that will have the Full Screen mode called on it. It defaults to the game canvas, but can be retargetted to any valid DOM element.
If you adjust this property it's up to you to see it has the correct CSS applied, and that you have contained the game canvas correctly.
Note that if you use a scale property of EXACT_FIT then fullScreenTarget will have its width and height style set to 100%.</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 class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fullScreenTarget</code></td>
<td class="type">
<span class="param-type">any</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-129">line 129</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="game"><span class="type-signature"></span>game<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>game</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
2013-10-03 00:21:08 +00:00
</td>
2013-11-28 15:57:09 +00:00
<td class="description last"><p>A reference to the currently running game.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-21">line 21</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-09-09 14:36:56 +00:00
<h4 class="name" id="grid"><span class="type-signature"></span>grid<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2014-09-09 14:36:56 +00:00
<td class="name"><code>grid</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
2014-09-09 14:36:56 +00:00
<span class="param-type"><a href="Phaser.FlexGrid.html">Phaser.FlexGrid</a></span>
2013-10-03 00:21:08 +00:00
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>EXPERIMENTAL: A responsive grid on which you can align game objects.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-26">line 26</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="height"><span class="type-signature"></span>height<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>height</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type">number</span>
2013-10-03 00:21:08 +00:00
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>Height of the game after calculation.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-36">line 36</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="incorrectOrientation"><span class="type-signature"></span>incorrectOrientation<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>incorrectOrientation</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
<span class="param-type">boolean</span>
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>If <code>forceLandscape</code> or <code>forcePortrait</code> are true and the browser doesn't match that orientation this is set to <code>true</code>.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
2013-11-28 15:57:09 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
2013-10-03 00:21:08 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-79">line 79</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="isFullScreen"><span class="type-signature">&lt;readonly> </span>isFullScreen<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>isFullScreen</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type">boolean</span>
2013-10-03 00:21:08 +00:00
</td>
2013-11-28 15:57:09 +00:00
<td class="description last"><p>Returns true if the browser is in full screen mode, otherwise false.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-1124">line 1124</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="isLandscape"><span class="type-signature">&lt;readonly> </span>isLandscape<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>isLandscape</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type">boolean</span>
2013-10-03 00:21:08 +00:00
</td>
2013-11-28 15:57:09 +00:00
<td class="description last"><p>Returns true if the browser dimensions match a landscape display.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-1150">line 1150</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="isPortrait"><span class="type-signature">&lt;readonly> </span>isPortrait<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>isPortrait</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type">boolean</span>
2013-10-03 00:21:08 +00:00
</td>
2013-11-28 15:57:09 +00:00
<td class="description last"><p>Returns true if the browser dimensions match a portrait display.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-1137">line 1137</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="leaveFullScreen"><span class="type-signature"></span>leaveFullScreen<span class="type-signature"></span></h4>
</dt>
<dd>
<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>leaveFullScreen</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>
</td>
<td class="description last"><p>The event that is dispatched when the browser leaves full screen mode (if it supports the FullScreen API).</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-139">line 139</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="leaveIncorrectOrientation"><span class="type-signature"></span>leaveIncorrectOrientation<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>leaveIncorrectOrientation</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>
2013-10-03 00:21:08 +00:00
</td>
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The event that is dispatched when the browser leaves an incorrect orientation, as defined by forceOrientation.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-121">line 121</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="margin"><span class="type-signature">&lt;readonly> </span>margin<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>margin</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
2013-10-03 00:21:08 +00:00
</td>
2014-04-29 14:39:02 +00:00
<td class="description last"><p>If the game canvas is set to align by adjusting the margin, the margin calculation values are stored in this Point.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-174">line 174</a>
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="maxHeight"><span class="type-signature"></span>maxHeight<span class="type-signature"></span></h4>
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>maxHeight</code></td>
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type">number</span>
</td>
<td class="description last"><p>Maximum height the canvas should be scaled to (in pixels). If null it will scale to whatever height the browser can handle.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-56">line 56</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="maxIterations"><span class="type-signature"></span>maxIterations<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>maxIterations</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type">number</span>
2013-10-03 00:21:08 +00:00
</td>
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The maximum number of times it will try to resize the canvas to fill the browser.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
2013-11-28 15:57:09 +00:00
<dd class="tag-default"><ul class="dummy"><li>5</li></ul></dd>
2013-10-03 00:21:08 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-101">line 101</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="maxWidth"><span class="type-signature"></span>maxWidth<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>maxWidth</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type">number</span>
2013-10-03 00:21:08 +00:00
</td>
<td class="description last"><p>Maximum width the canvas should be scaled to (in pixels). If null it will scale to whatever width the browser can handle.</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-46">line 46</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="minHeight"><span class="type-signature"></span>minHeight<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>minHeight</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type">number</span>
2013-10-03 00:21:08 +00:00
</td>
2013-11-28 15:57:09 +00:00
<td class="description last"><p>Minimum height the canvas should be scaled to (in pixels).</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-51">line 51</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-28 15:57:09 +00:00
<h4 class="name" id="minWidth"><span class="type-signature"></span>minWidth<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>minWidth</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
<span class="param-type">number</span>
</td>
2013-11-28 15:57:09 +00:00
<td class="description last"><p>Minimum width the canvas should be scaled to (in pixels).</p></td>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-41">line 41</a>
</li></ul></dd>
</dl>
</dd>
<dt>
2014-09-09 14:36:56 +00:00
<h4 class="name" id="offset"><span class="type-signature"></span>offset<span class="type-signature"></span></h4>
</dt>
<dd>
<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>
2014-09-09 14:36:56 +00:00
<td class="name"><code>offset</code></td>
<td class="type">
2014-09-09 14:36:56 +00:00
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>Holds the offset coordinates of the Game.canvas from the top-left of the browser window (used by Input and other classes)</p></td>
</tr>
</tbody>
</table>
</dl>
2013-11-28 15:57:09 +00:00
2013-10-03 00:21:08 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-61">line 61</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
2013-11-28 15:57:09 +00:00
2013-10-03 00:21:08 +00:00
<dt>
2014-09-09 14:36:56 +00:00
<h4 class="name" id="onResize"><span class="type-signature"></span>onResize<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
2013-11-28 15:57:09 +00:00
<dl class="details">
2013-10-03 00:21:08 +00:00
2013-11-28 15:57:09 +00:00
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
2013-10-03 00:21:08 +00:00
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2014-09-09 14:36:56 +00:00
<td class="name"><code>onResize</code></td>
2013-10-03 00:21:08 +00:00
<td class="type">
2014-09-09 14:36:56 +00:00
<span class="param-type">function</span>
2013-10-03 00:21:08 +00:00
</td>
2014-09-09 14:36:56 +00:00
<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>
2013-10-03 00:21:08 +00:00
</tr>
</tbody>
</table>
2013-11-28 15:57:09 +00:00
</dl>
2013-10-03 00:21:08 +00:00
2014-09-09 14:36:56 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
2013-10-03 00:21:08 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-232">line 232</a>
2013-11-28 15:57:09 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-09-09 14:36:56 +00:00
<h4 class="name" id="onResizeContext"><span class="type-signature"></span>onResizeContext<span class="type-signature"></span></h4>
2013-11-28 15:57:09 +00:00
</dt>
<dd>
<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>
2014-09-09 14:36:56 +00:00
<td class="name"><code>onResizeContext</code></td>
2013-11-28 15:57:09 +00:00
<td class="type">
2014-09-09 14:36:56 +00:00
<span class="param-type">object</span>
2013-11-28 15:57:09 +00:00
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>The context in which the callback will be called.</p></td>
2013-11-28 15:57:09 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
2014-09-09 14:36:56 +00:00
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
2013-11-28 15:57:09 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-238">line 238</a>
2013-11-28 15:57:09 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-09-09 14:36:56 +00:00
<h4 class="name" id="orientation"><span class="type-signature"></span>orientation<span class="type-signature"></span></h4>
2013-11-28 15:57:09 +00:00
</dt>
<dd>
<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>
2014-09-09 14:36:56 +00:00
<td class="name"><code>orientation</code></td>
2013-11-28 15:57:09 +00:00
<td class="type">
2014-09-09 14:36:56 +00:00
<span class="param-type">number</span>
2013-11-28 15:57:09 +00:00
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>The orientation value of the game (as defined by window.orientation if set). 90 = landscape. 0 = portrait.</p></td>
2013-11-28 15:57:09 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-144">line 144</a>
2013-11-28 15:57:09 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-09-09 14:36:56 +00:00
<h4 class="name" id="pageAlignHorizontally"><span class="type-signature"></span>pageAlignHorizontally<span class="type-signature"></span></h4>
2013-11-28 15:57:09 +00:00
</dt>
<dd>
<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>
2014-09-09 14:36:56 +00:00
<td class="name"><code>pageAlignHorizontally</code></td>
2013-11-28 15:57:09 +00:00
<td class="type">
2014-09-09 14:36:56 +00:00
<span class="param-type">boolean</span>
2013-11-28 15:57:09 +00:00
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>If you wish to align your game in the middle of the page then you can set this value to true.
It will place a re-calculated margin-left pixel value onto the canvas element which is updated on orientation/resizing events.
It doesn't care about any other DOM element that may be on the page, it literally just sets the margin.</p></td>
2013-11-28 15:57:09 +00:00
</tr>
</tbody>
</table>
</dl>
2014-09-09 14:36:56 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
2013-11-28 15:57:09 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-87">line 87</a>
2013-11-28 15:57:09 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-09-09 14:36:56 +00:00
<h4 class="name" id="pageAlignVertically"><span class="type-signature"></span>pageAlignVertically<span class="type-signature"></span></h4>
2013-11-28 15:57:09 +00:00
</dt>
<dd>
<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>
2014-09-09 14:36:56 +00:00
<td class="name"><code>pageAlignVertically</code></td>
2013-11-28 15:57:09 +00:00
<td class="type">
2014-09-09 14:36:56 +00:00
<span class="param-type">boolean</span>
2013-11-28 15:57:09 +00:00
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>If you wish to align your game in the middle of the page then you can set this value to true.
It will place a re-calculated margin-left pixel value onto the canvas element which is updated on orientation/resizing events.
It doesn't care about any other DOM element that may be on the page, it literally just sets the margin.</p></td>
2013-11-28 15:57:09 +00:00
</tr>
</tbody>
</table>
</dl>
2014-09-09 14:36:56 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
2013-11-28 15:57:09 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-95">line 95</a>
</li></ul></dd>
</dl>
</dd>
<dt>
2014-09-09 14:36:56 +00:00
<h4 class="name" id="parentIsWindow"><span class="type-signature">&lt;readonly> </span>parentIsWindow<span class="type-signature"></span></h4>
</dt>
<dd>
<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>
2014-09-09 14:36:56 +00:00
<td class="name"><code>parentIsWindow</code></td>
<td class="type">
2014-09-09 14:36:56 +00:00
<span class="param-type">boolean</span>
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>If the parent container of the game is the browser window, rather than a div, this is set to <code>true</code>.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-208">line 208</a>
</li></ul></dd>
</dl>
</dd>
<dt>
2014-09-09 14:36:56 +00:00
<h4 class="name" id="parentNode"><span class="type-signature">&lt;readonly> </span>parentNode<span class="type-signature"></span></h4>
</dt>
<dd>
<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>
2014-09-09 14:36:56 +00:00
<td class="name"><code>parentNode</code></td>
<td class="type">
2014-09-09 14:36:56 +00:00
<span class="param-type">object</span>
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>The fully parsed parent container of the game. If the parent is the browser window this will be <code>null</code>.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-214">line 214</a>
2013-11-28 15:57:09 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-09-09 14:36:56 +00:00
<h4 class="name" id="parentScaleFactor"><span class="type-signature">&lt;readonly> </span>parentScaleFactor<span class="type-signature"></span></h4>
2013-11-28 15:57:09 +00:00
</dt>
<dd>
<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>
2014-09-09 14:36:56 +00:00
<td class="name"><code>parentScaleFactor</code></td>
2013-11-28 15:57:09 +00:00
<td class="type">
2014-09-09 14:36:56 +00:00
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
2013-11-28 15:57:09 +00:00
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>The scale of the game in relation to its parent container.</p></td>
2013-11-28 15:57:09 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-220">line 220</a>
2013-11-28 15:57:09 +00:00
</li></ul></dd>
</dl>
</dd>
2014-09-09 14:36:56 +00:00
2013-11-28 15:57:09 +00:00
<dt>
2014-09-09 14:36:56 +00:00
<h4 class="name" id="scaleFactor"><span class="type-signature">&lt;readonly> </span>scaleFactor<span class="type-signature"></span></h4>
2013-11-28 15:57:09 +00:00
</dt>
<dd>
2014-09-09 14:36:56 +00:00
<dl class="details">
2013-11-28 15:57:09 +00:00
2014-09-09 14:36:56 +00:00
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
2013-11-28 15:57:09 +00:00
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2014-09-09 14:36:56 +00:00
<td class="name"><code>scaleFactor</code></td>
2013-11-28 15:57:09 +00:00
<td class="type">
2014-09-09 14:36:56 +00:00
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
2013-11-28 15:57:09 +00:00
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>The scale factor based on the game dimensions vs. the scaled dimensions.</p></td>
2013-11-28 15:57:09 +00:00
</tr>
</tbody>
</table>
2014-09-09 14:36:56 +00:00
</dl>
2013-11-28 15:57:09 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-162">line 162</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-09-09 14:36:56 +00:00
<h4 class="name" id="scaleFactorInversed"><span class="type-signature">&lt;readonly> </span>scaleFactorInversed<span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<dl class="details">
2014-09-09 14:36:56 +00:00
<h5 class="subsection-title">Properties:</h5>
2013-10-03 00:21:08 +00:00
2014-09-09 14:36:56 +00:00
<dl>
2013-10-03 00:21:08 +00:00
2014-09-09 14:36:56 +00:00
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
2013-10-03 00:21:08 +00:00
2014-09-09 14:36:56 +00:00
<th>Type</th>
2013-10-03 00:21:08 +00:00
2014-09-09 14:36:56 +00:00
2013-10-03 00:21:08 +00:00
2014-09-09 14:36:56 +00:00
2013-10-03 00:21:08 +00:00
2014-09-09 14:36:56 +00:00
<th class="last">Description</th>
</tr>
</thead>
2013-10-03 00:21:08 +00:00
2014-09-09 14:36:56 +00:00
<tbody>
2013-10-03 00:21:08 +00:00
2014-09-09 14:36:56 +00:00
<tr>
<td class="name"><code>scaleFactorInversed</code></td>
2013-10-03 00:21:08 +00:00
2014-09-09 14:36:56 +00:00
<td class="type">
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
</td>
<td class="description last"><p>The inversed scale factor. The displayed dimensions divided by the game dimensions.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-168">line 168</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="scaleMode"><span class="type-signature"></span>scaleMode<span class="type-signature"></span></h4>
</dt>
<dd>
<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>scaleMode</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The scaling method used by the ScaleManager.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-1101">line 1101</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="sourceAspectRatio"><span class="type-signature">&lt;readonly> </span>sourceAspectRatio<span class="type-signature"></span></h4>
</dt>
<dd>
<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>sourceAspectRatio</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The aspect ratio (width / height) of the original game dimensions.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-192">line 192</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="trackParentInterval"><span class="type-signature"></span>trackParentInterval<span class="type-signature"></span></h4>
</dt>
<dd>
<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>trackParentInterval</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The interval (in ms) upon which the ScaleManager checks if the parent has changed dimensions. Only applies if scaleMode = RESIZE and the game is contained within another html element.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>2000</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-226">line 226</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="width"><span class="type-signature"></span>width<span class="type-signature"></span></h4>
</dt>
<dd>
<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>width</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Width of the game after calculation.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-31">line 31</a>
</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="boot"><span class="type-signature"></span>boot<span class="signature">()</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>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-416">line 416</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="checkOrientation"><span class="type-signature"></span>checkOrientation<span class="signature">(event)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>window.orientationchange event handler.</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>event</code></td>
<td class="type">
<span class="param-type">Event</span>
</td>
<td class="description last"><p>The orientationchange event data.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-630">line 630</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="checkOrientationState"><span class="type-signature"></span>checkOrientationState<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the browser is in the correct orientation for your game (if forceLandscape or forcePortrait have been set)</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-592">line 592</a>
</li></ul></dd>
2013-10-03 00:21:08 +00:00
</dl>
</dd>
<dt>
<h4 class="name" id="checkResize"><span class="type-signature"></span>checkResize<span class="signature">(event)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
2014-09-09 14:36:56 +00:00
<p>window.resize event handler.</p>
2013-10-03 00:21:08 +00:00
</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>event</code></td>
<td class="type">
<span class="param-type">Event</span>
</td>
<td class="description last"><p>The resize event data.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-658">line 658</a>
</li></ul></dd>
</dl>
</dd>
<dt>
2014-09-09 14:36:56 +00:00
<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">
2014-09-09 14:36:56 +00:00
<p>If you need your game to run in only one orientation you can force that to happen.</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">
2013-11-28 15:57:09 +00:00
&lt;optional><br>
</td>
<td class="default">
2013-11-28 15:57:09 +00:00
false
</td>
<td class="description last"><p>true if the game should run in portrait mode only.</p></td>
</tr>
2014-09-09 14:36:56 +00:00
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-576">line 576</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="fullScreenChange"><span class="type-signature">&lt;protected> </span>fullScreenChange<span class="signature">(event)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Called automatically when the browser enters of leaves full screen 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>
2014-09-09 14:36:56 +00:00
<td class="name"><code>event</code></td>
<td class="type">
2014-09-09 14:36:56 +00:00
<span class="param-type">Event</span>
</td>
2014-09-09 14:36:56 +00:00
<td class="description last"><p>The fullscreenchange event</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-1023">line 1023</a>
2013-11-01 18:16:52 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-09-09 14:36:56 +00:00
<h4 class="name" id="parseConfig"><span class="type-signature"></span>parseConfig<span class="signature">(config)</span><span class="type-signature"></span></h4>
2013-11-01 18:16:52 +00:00
</dt>
<dd>
<div class="description">
2014-09-09 14:36:56 +00:00
<p>Parses the Game configuration object.</p>
2013-11-01 18:16:52 +00:00
</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>
2014-09-09 14:36:56 +00:00
<td class="name"><code>config</code></td>
2013-11-01 18:16:52 +00:00
<td class="type">
2014-09-09 14:36:56 +00:00
<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="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-311">line 311</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="preUpdate"><span class="type-signature">&lt;protected> </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="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-500">line 500</a>
</li></ul></dd>
2013-11-01 18:16:52 +00:00
2014-09-09 14:36:56 +00:00
2013-11-01 18:16:52 +00:00
2014-09-09 14:36:56 +00:00
2013-11-01 18:16:52 +00:00
2014-09-09 14:36:56 +00:00
</dl>
2013-11-01 18:16:52 +00:00
2014-09-09 14:36:56 +00:00
2013-11-01 18:16:52 +00:00
2014-09-09 14:36:56 +00:00
2013-11-01 18:16:52 +00:00
2014-09-09 14:36:56 +00:00
</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>Re-calculate scale mode and update screen size. This only applies if ScaleMode is not set to RESIZE.</p>
</div>
2013-11-01 18:16:52 +00:00
2014-09-09 14:36:56 +00:00
2013-11-01 18:16:52 +00:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-726">line 726</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-09-09 14:36:56 +00:00
<h4 class="name" id="setExactFit"><span class="type-signature"></span>setExactFit<span class="signature">()</span><span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<div class="description">
2014-09-09 14:36:56 +00:00
<p>Sets the width and height values of the canvas, no larger than the maxWidth/Height.</p>
2013-10-03 00:21:08 +00:00
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-950">line 950</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-09-09 14:36:56 +00:00
<h4 class="name" id="setMaximum"><span class="type-signature"></span>setMaximum<span class="signature">()</span><span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<div class="description">
2014-09-09 14:36:56 +00:00
<p>Sets this.width equal to window.innerWidth and this.height equal to window.innerHeight.</p>
2013-10-03 00:21:08 +00:00
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-924">line 924</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-09-09 14:36:56 +00:00
<h4 class="name" id="setResizeCallback"><span class="type-signature"></span>setResizeCallback<span class="signature">(callback, context)</span><span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<div class="description">
2014-09-09 14:36:56 +00:00
<p>Sets the callback that will be called when the window resize event occurs, or if set the parent container changes dimensions.
Use this to handle responsive game layout options.
Note that the callback will only be called if the ScaleManager.scaleMode is set to RESIZE.</p>
2013-10-03 00:21:08 +00:00
</div>
2014-09-09 14:36:56 +00:00
<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>
2013-10-03 00:21:08 +00:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-458">line 458</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setScreenSize"><span class="type-signature"></span>setScreenSize<span class="signature">(force)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
2014-09-09 14:36:56 +00:00
<p>Set screen size automatically based on the scaleMode. This is only needed if ScaleMode is not set to RESIZE.</p>
2013-10-03 00:21:08 +00:00
</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>force</code></td>
<td class="type">
<span class="param-type">boolean</span>
2013-10-03 00:21:08 +00:00
</td>
<td class="description last"><p>If force is true it will try to resize the game regardless of the document dimensions.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-772">line 772</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setShowAll"><span class="type-signature"></span>setShowAll<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Calculates the multiplier needed to scale the game proportionally.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-936">line 936</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setSize"><span class="type-signature"></span>setSize<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Sets the canvas style width and height values based on minWidth/Height and maxWidth/Height.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-837">line 837</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setupScale"><span class="type-signature"></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>
</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="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-336">line 336</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2013-11-01 18:16:52 +00:00
<h4 class="name" id="startFullScreen"><span class="type-signature"></span>startFullScreen<span class="signature">(antialias)</span><span class="type-signature"></span></h4>
2013-10-03 00:21:08 +00:00
</dt>
<dd>
<div class="description">
<p>Tries to enter the browser into full screen mode.
Please note that this needs to be supported by the web browser and isn't the same thing as setting your game to fill the browser.</p>
</div>
2013-11-01 18:16:52 +00:00
<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>antialias</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>You can toggle the anti-alias feature of the canvas before jumping in to full screen (false = retain pixel art, true = smooth art)</p></td>
</tr>
</tbody>
</table>
2013-10-03 00:21:08 +00:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-980">line 980</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="stopFullScreen"><span class="type-signature"></span>stopFullScreen<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Stops full screen mode if the browser is in it.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-09-09 14:36:56 +00:00
<a href="ScaleManager.js.html">core/ScaleManager.js</a>, <a href="ScaleManager.js.html#sunlight-1-line-1013">line 1013</a>
2013-10-03 00:21:08 +00:00
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
2013-10-03 00:21:08 +00:00
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
2014-09-09 14:36:56 +00:00
on Tue Sep 09 2014 15:29:38 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
2013-10-03 00:21:08 +00:00
</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( {
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
2013-10-03 00:21:08 +00:00
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>