phaser/docs/Phaser.Utils.Debug.html

7475 lines
121 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: Debug</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
2014-11-15 20:01:46 +00:00
<link type="text/css" rel="stylesheet" href="styles/default.css">
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
2014-11-25 00:23:44 +00:00
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
2014-11-25 00:23:44 +00:00
<div style="position: absolute; width: 143px; height: 31px; right: 10px; top: 10px; z-index: 1050"><a href="http://phaser.io"><img src="img/phaser.png" border="0" /></a></div>
<div class="navbar-inner">
2014-11-25 00:23:44 +00:00
<a class="brand" href="index.html">Phaser API</a>
<ul class="nav">
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
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>
</li>
2015-10-15 11:06:38 +00:00
<li class="class-depth-0">
<a href="Phaser.KeyCode.html">KeyCode</a>
</li>
2014-11-15 20:01:46 +00:00
<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 ">
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<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>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.ArraySet.html">ArraySet</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayUtils.html">ArrayUtils</a>
</li>
2014-10-09 15:12:53 +00:00
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Button.html">Button</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-2">
<a href="Phaser.Component.Angle.html">Angle</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Animation.html">Animation</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.AutoCull.html">AutoCull</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Bounds.html">Bounds</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.BringToTop.html">BringToTop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Core.html">Core</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Crop.html">Crop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Delta.html">Delta</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Destroy.html">Destroy</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.FixedToCamera.html">FixedToCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Health.html">Health</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InCamera.html">InCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InputEnabled.html">InputEnabled</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InWorld.html">InWorld</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LifeSpan.html">LifeSpan</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LoadTexture.html">LoadTexture</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Overlap.html">Overlap</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.PhysicsBody.html">PhysicsBody</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Reset.html">Reset</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.ScaleMinMax.html">ScaleMinMax</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Smoothed.html">Smoothed</a>
</li>
2015-07-22 14:31:30 +00:00
<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>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Device.html">Device</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.DeviceButton.html">DeviceButton</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.DOM.html">DOM</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Easing.html">Easing</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Back.html">Back</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Events.html">Events</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Filter.html">Filter</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-1">
<a href="Phaser.FlexGrid.html">FlexGrid</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexLayer.html">FlexLayer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<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">
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">
<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>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.ImageCollection.html">ImageCollection</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Input.html">Input</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Key.html">Key</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<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">
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<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>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Math.html">Math</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.Matrix.html">Matrix</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Mouse.html">Mouse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<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">
<a href="Phaser.Particles.html">Particles</a>
</li>
2014-10-09 15:12:53 +00:00
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.html">Physics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-3">
2015-08-24 14:43:45 +00:00
<a href="Phaser.Physics.Arcade.TilemapCollision.html">TilemapCollision</a>
2015-03-23 23:46:30 +00:00
</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">
<a href="Phaser.Plugin.html">Plugin</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Point.html">Point</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Pointer.html">Pointer</a>
</li>
2015-10-15 11:06:38 +00:00
<li class="class-depth-1">
<a href="Phaser.PointerMode.html">PointerMode</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">
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<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">
<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>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.RoundedRectangle.html">RoundedRectangle</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">
<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">
<a href="Phaser.Sound.html">Sound</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<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">
<a href="Phaser.Stage.html">Stage</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.State.html">State</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<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">
<a href="Phaser.Touch.html">Touch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenData.html">TweenData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2015-07-22 14:31:30 +00:00
<a href="Phaser.Video.html">Video</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
2015-07-22 14:31:30 +00:00
<a href="Phaser.World.html">World</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-07-22 14:31:30 +00:00
<a href="PIXI.AbstractFilter.html">AbstractFilter</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-07-22 14:31:30 +00:00
<a href="PIXI.BaseTexture.html">BaseTexture</a>
2014-11-15 20:01:46 +00:00
</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>
2015-08-24 14:43:45 +00:00
<li class="class-depth-1">
<a href="PIXI.CanvasPool.html">CanvasPool</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="PIXI.CanvasRenderer.html">CanvasRenderer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasTinter.html">CanvasTinter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObject.html">DisplayObject</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObjectContainer.html">DisplayObjectContainer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Event.html">Event</a>
</li>
<li class="class-depth-1">
<a href="PIXI.EventTarget.html">EventTarget</a>
</li>
<li class="class-depth-1">
<a href="PIXI.FilterTexture.html">FilterTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.GraphicsData.html">GraphicsData</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PIXI.html">PIXI</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiFastShader.html">PixiFastShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiShader.html">PixiShader</a>
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.PolyK.html">PolyK</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.PrimitiveShader.html">PrimitiveShader</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.RenderTexture.html">RenderTexture</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Rope.html">Rope</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Sprite.html">Sprite</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.SpriteBatch.html">SpriteBatch</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Strip.html">Strip</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.StripShader.html">StripShader</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Texture.html">Texture</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.TilingSprite.html">TilingSprite</a>
2014-11-15 20:01:46 +00:00
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a>
2014-11-25 00:23:44 +00:00
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLRenderer.html">WebGLRenderer</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
</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">
2015-07-22 14:31:30 +00:00
<a href="global.html#AUTO">AUTO</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#BITMAPDATA">BITMAPDATA</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#BITMAPTEXT">BITMAPTEXT</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#blendModes">blendModes</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<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#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#DOWN">DOWN</a>
</li>
<li class="class-depth-0">
<a href="global.html#ELLIPSE">ELLIPSE</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#EMITTER">EMITTER</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#GAMES">GAMES</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#GRAPHICS">GRAPHICS</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#GROUP">GROUP</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#HEADLESS">HEADLESS</a>
</li>
<li class="class-depth-0">
<a href="global.html#IMAGE">IMAGE</a>
</li>
<li class="class-depth-0">
<a href="global.html#LEFT">LEFT</a>
</li>
<li class="class-depth-0">
<a href="global.html#LINE">LINE</a>
</li>
<li class="class-depth-0">
<a href="global.html#MATRIX">MATRIX</a>
</li>
<li class="class-depth-0">
<a href="global.html#NONE">NONE</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#RECTANGLE">RECTANGLE</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#ROPE">ROPE</a>
</li>
<li class="class-depth-0">
<a href="global.html#ROUNDEDRECTANGLE">ROUNDEDRECTANGLE</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#scaleModes">scaleModes</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#SPRITE">SPRITE</a>
</li>
<li class="class-depth-0">
<a href="global.html#SPRITEBATCH">SPRITEBATCH</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#TEXT">TEXT</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<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#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#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>
2014-11-15 20:01:46 +00:00
</li>
</ul>
</li>
2014-11-25 00:23:44 +00:00
2014-11-15 20:01:46 +00:00
<li class="dropdown">
2014-11-25 00:23:44 +00:00
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Core<b class="caret"></b></a>
<ul class="dropdown-menu ">
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="Phaser.Game.html">Game</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Group.html">Group</a></li>
<li class="class-depth-1"><a href="Phaser.World.html">World</a></li>
<li class="class-depth-1"><a href="Phaser.Loader.html">Loader</a></li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="Phaser.Cache.html">Cache</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Time.html">Time</a></li>
<li class="class-depth-1"><a href="Phaser.Camera.html">Camera</a></li>
<li class="class-depth-1"><a href="Phaser.StateManager.html">State Manager</a></li>
<li class="class-depth-1"><a href="Phaser.TweenManager.html">Tween Manager</a></li>
<li class="class-depth-1"><a href="Phaser.SoundManager.html">Sound Manager</a></li>
2015-01-06 06:57:25 +00:00
<li class="class-depth-1"><a href="Phaser.Input.html">Input Manager</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.ScaleManager.html">Scale Manager</a></li>
</ul>
</li>
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Game Objects<b class="caret"></b></a>
2014-11-15 20:01:46 +00:00
<ul class="dropdown-menu ">
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.GameObjectFactory.html">Factory (game.add)</a></li>
<li class="class-depth-1"><a href="Phaser.GameObjectCreator.html">Creator (game.make)</a></li>
<li class="class-depth-1"><a href="Phaser.Sprite.html">Sprite</a></li>
<li class="class-depth-1"><a href="Phaser.Image.html">Image</a></li>
<li class="class-depth-1"><a href="Phaser.Sound.html">Sound</a></li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="Phaser.Video.html">Video</a></li>
2015-01-06 06:57:25 +00:00
<li class="class-depth-1"><a href="Phaser.Particles.Arcade.Emitter.html">Particle Emitter</a></li>
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="Phaser.Particle.html">Particle</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Text.html">Text</a></li>
<li class="class-depth-1"><a href="Phaser.Tween.html">Tween</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapText.html">BitmapText</a></li>
<li class="class-depth-1"><a href="Phaser.Tilemap.html">Tilemap</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapData.html">BitmapData</a></li>
<li class="class-depth-1"><a href="Phaser.RetroFont.html">RetroFont</a></li>
<li class="class-depth-1"><a href="Phaser.Button.html">Button</a></li>
<li class="class-depth-1"><a href="Phaser.Animation.html">Animation</a></li>
<li class="class-depth-1"><a href="Phaser.Graphics.html">Graphics</a></li>
<li class="class-depth-1"><a href="Phaser.RenderTexture.html">RenderTexture</a></li>
<li class="class-depth-1"><a href="Phaser.TileSprite.html">TileSprite</a></li>
</ul>
</li>
<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>
2015-07-22 14:31:30 +00:00
<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>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li>
2015-07-22 14:31:30 +00:00
<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>
2014-11-25 00:23:44 +00:00
</ul>
</li>
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Physics<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Physics.Arcade.html">Arcade Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Arcade.Body.html">Body</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.P2.html">P2 Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Body.html">Body</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Spring.html">Spring</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.Ninja.html">Ninja Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Body.html">Body</a></li>
2014-11-15 20:01:46 +00:00
</ul>
</li>
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">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>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="Phaser.DeviceButton.html">Device Button</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Mouse.html">Mouse</a></li>
<li class="class-depth-1"><a href="Phaser.Keyboard.html">Keyboard</a></li>
<li class="class-depth-1"><a href="Phaser.Key.html">Key</a></li>
<li class="class-depth-1"><a href="Phaser.Gamepad.html">Gamepad</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Community<b class="caret"></b></a>
<ul class="dropdown-menu ">
2015-03-26 02:55:18 +00:00
<li class="class-depth-1"><a href="http://phaser.io">Phaser Web Site</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li>
2015-03-26 02:55:18 +00:00
<li class="class-depth-1"><a href="http://phaser.io/examples">Phaser Examples</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser-plugins">Phaser Plugins</a></li>
<li class="class-depth-1"><a href="http://www.html5gamedevs.com/forum/14-phaser/">Forum</a></li>
<li class="class-depth-1"><a href="http://stackoverflow.com/questions/tagged/phaser-framework">Stack Overflow</a></li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="http://phaser.io/learn">Tutorials</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="https://confirmsubscription.com/h/r/369DE48E3E86AF1E">Newsletter</a></li>
2015-03-26 02:55:18 +00:00
<li class="class-depth-1"><a href="http://phaser.io/community/twitter">Twitter</a></li>
<li class="class-depth-1"><a href="http://phaser.io/community/irc">IRC</a></li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-1"><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a></li>
2014-11-25 00:23:44 +00:00
</ul>
</li>
2014-11-15 20:01:46 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
2014-11-25 00:23:44 +00:00
<!--<h1 class="page-title">Class: Debug</h1>-->
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.html">Phaser</a><a href="Phaser.Utils.html">.Utils</a>.</span>
Debug
</h2>
</header>
<article>
<div class="container-overview">
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="Debug"><span class="type-signature"></span>new Debug<span class="signature">(game)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>A collection of methods for displaying debug information about game objects.
If your game is running in WebGL then Debug will create a Sprite that is placed at the top of the Stage display list and bind a canvas texture
2014-11-15 20:01:46 +00:00
to it, which must be uploaded every frame. Be advised: this is very expensive, especially in browsers like Firefox. So please only enable Debug
in WebGL mode if you really need it (or your desktop can cope with it well) and disable it for production!
If your game is using a Canvas renderer then the debug information is literally drawn on the top of the active game canvas and no Sprite is used.</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>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-18">line 18</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
2014-02-05 06:29:17 +00:00
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="bmd"><span class="type-signature"></span>bmd<span class="type-signature"> :<a href="Phaser.BitmapData.html">Phaser.BitmapData</a></span></h4>
2014-02-05 06:29:17 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>In WebGL mode this BitmapData contains a copy of the debug canvas.</p>
</div>
2014-02-05 06:29:17 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-33">line 33</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
</dl>
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
</dd>
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
id="canvas"><span class="type-signature"></span>canvas<span class="type-signature"> :HTMLCanvasElement</span></h4>
</dt>
<dd>
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The canvas to which Debug calls draws.</p>
</div>
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-38">line 38</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-02-05 06:29:17 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="columnWidth"><span class="type-signature"></span>columnWidth<span class="type-signature"> :number</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The spacing between columns.</p>
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-54">line 54</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
</dl>
2014-11-15 20:01:46 +00:00
</dd>
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
id="context"><span class="type-signature"></span>context<span class="type-signature"> :CanvasRenderingContext2D</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The 2d context of the canvas.</p>
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-43">line 43</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="currentAlpha"><span class="type-signature"></span>currentAlpha<span class="type-signature"> :number</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2015-07-22 14:31:30 +00:00
<p>The alpha of the Debug context, set before all debug information is rendered to it.</p>
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>1</li></ul></dd>
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-82">line 82</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="currentX"><span class="type-signature"></span>currentX<span class="type-signature"> :number</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The current X position the debug information will be rendered at.</p>
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-70">line 70</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="currentY"><span class="type-signature"></span>currentY<span class="type-signature"> :number</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The current Y position the debug information will be rendered at.</p>
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-76">line 76</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="dirty"><span class="type-signature"></span>dirty<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Does the canvas need re-rendering?</p>
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-87">line 87</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="font"><span class="type-signature"></span>font<span class="type-signature"> :string</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The font that the debug information is rendered in.</p>
</div>
<dl class="details">
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>'14px Courier'</li></ul></dd>
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-49">line 49</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-02-05 06:29:17 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="game"><span class="type-signature"></span>game<span class="type-signature"> :<a href="Phaser.Game.html">Phaser.Game</a></span></h4>
2014-02-05 06:29:17 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>A reference to the currently running Game.</p>
</div>
2014-02-05 06:29:17 +00:00
<dl class="details">
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-23">line 23</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
</dl>
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
</dd>
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
id="lineHeight"><span class="type-signature"></span>lineHeight<span class="type-signature"> :number</span></h4>
</dt>
<dd>
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The line height between the debug text.</p>
</div>
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-59">line 59</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-02-05 06:29:17 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="renderShadow"><span class="type-signature"></span>renderShadow<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Should the text be rendered with a slight shadow? Makes it easier to read on different types of background.</p>
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-64">line 64</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
</dl>
2014-11-15 20:01:46 +00:00
</dd>
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
id="sprite"><span class="type-signature"></span>sprite<span class="type-signature"> :<a href="Phaser.Image.html">Phaser.Image</a></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>If debugging in WebGL mode we need this.</p>
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-28">line 28</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="body"><span class="type-signature"></span>body<span class="signature">(sprite, <span class="optional">color</span>, <span class="optional">filled</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2015-07-22 14:31:30 +00:00
<p>Render a Sprites Physics body if it has one set. The body is rendered as a filled or stroked rectangle.
This only works for Arcade Physics, Ninja Physics (AABB and Circle only) and Box2D Physics bodies.
To display a P2 Physics body you should enable debug mode on the body when creating it.</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>
2013-11-28 15:57:09 +00:00
<tr>
<td class="name"><code>sprite</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>The Sprite who's body will be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
2013-11-28 15:57:09 +00:00
<td class="type">
<span class="param-type">string</span>
2013-11-28 15:57:09 +00:00
</td>
<td class="attributes">
&lt;optional><br>
2013-11-28 15:57:09 +00:00
</td>
<td class="default">
2014-07-10 19:31:11 +00:00
'rgba(0,255,0,0.4)'
2013-11-28 15:57:09 +00:00
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>Color of the debug rectangle to be rendered. The format is a CSS color string such as '#ff0000' or 'rgba(255,0,0,0.5)'.</p></td>
2013-11-28 15:57:09 +00:00
</tr>
<tr>
<td class="name"><code>filled</code></td>
<td class="type">
<span class="param-type">boolean</span>
2014-02-05 06:29:17 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
2014-02-05 06:29:17 +00:00
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>Render the body as a filled rectangle (true) or a stroked rectangle (false)</p></td>
2014-02-05 06:29:17 +00:00
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-720">line 720</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-02-05 06:29:17 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="bodyInfo"><span class="type-signature"></span>bodyInfo<span class="signature">(sprite, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4>
2014-02-05 06:29:17 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
<div class="description">
<p>Render a Sprites Physic Body information.</p>
2014-02-05 06:29:17 +00:00
</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>
2014-02-05 06:29:17 +00:00
<td class="type">
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
2014-02-05 06:29:17 +00:00
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The sprite to be rendered.</p></td>
2014-02-05 06:29:17 +00:00
</tr>
<tr>
<td class="name"><code>x</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>X position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>y</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>Y position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgb(255,255,255)'
</td>
<td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-754">line 754</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-02-05 06:29:17 +00:00
</dl>
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
</dd>
2014-02-05 06:29:17 +00:00
2014-02-05 06:29:17 +00:00
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="boot"><span class="type-signature">&lt;internal> </span>boot<span class="signature">()</span><span class="type-signature"></span></h4>
2014-02-05 06:29:17 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
<div class="description">
<p>Internal method that boots the debug displayer.</p>
</div>
2014-02-05 06:29:17 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<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>
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-93">line 93</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="box2dBody"><span class="type-signature"></span>box2dBody<span class="signature">(sprite, <span class="optional">color</span>)</span><span class="type-signature"></span></h4>
2014-10-09 15:12:53 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
<div class="description">
<p>Renders 'debug draw' data for the given Box2D body.
This uses the standard debug drawing feature of Box2D, so colors will be decided by the Box2D engine.</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>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The sprite whos body will be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgb(0,255,0)'
</td>
<td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-801">line 801</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-10-09 15:12:53 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="box2dWorld"><span class="type-signature"></span>box2dWorld<span class="signature">()</span><span class="type-signature"></span></h4>
2014-10-09 15:12:53 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
<div class="description">
<p>Renders 'debug draw' data for the Box2D world if it exists.
This uses the standard debug drawing feature of Box2D, so colors will be decided by
the Box2D engine.</p>
</div>
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-783">line 783</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-10-09 15:12:53 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="cameraInfo"><span class="type-signature"></span>cameraInfo<span class="signature">(camera, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Render camera information including dimensions and location.</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>camera</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Camera.html">Phaser.Camera</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The Phaser.Camera to show the debug information for.</p></td>
</tr>
<tr>
<td class="name"><code>x</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>X position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>y</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>Y position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgb(255,255,255)'
</td>
<td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-258">line 258</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2015-08-24 14:43:45 +00:00
id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2015-08-24 14:43:45 +00:00
<p>Destroy this object.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-817">line 817</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-10-15 11:06:38 +00:00
id="geom"><span class="type-signature"></span>geom<span class="signature">(object, <span class="optional">color</span>, <span class="optional">filled</span>, <span class="optional">forceType</span>)</span><span class="type-signature"></span></h4>
2015-08-24 14:43:45 +00:00
</dt>
<dd>
<div class="description">
2015-10-15 11:06:38 +00:00
<p>Renders a Phaser geometry object including Rectangle, Circle, Point or Line.</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>object</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>
|
2015-10-15 11:06:38 +00:00
<span class="param-type"><a href="Phaser.Circle.html">Phaser.Circle</a></span>
|
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
|
<span class="param-type"><a href="Phaser.Line.html">Phaser.Line</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The geometry object to render.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>Color of the debug info to be rendered (format is css color string).</p></td>
</tr>
<tr>
<td class="name"><code>filled</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>Render the objected as a filled (default, true) or a stroked (false)</p></td>
</tr>
2015-10-15 11:06:38 +00:00
<tr>
<td class="name"><code>forceType</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>Force rendering of a specific type. If 0 no type will be forced, otherwise 1 = Rectangle, 2 = Circle, 3 = Point and 4 = Line.</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-553">line 553</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2015-10-15 11:06:38 +00:00
id="geom"><span class="type-signature"></span>geom<span class="signature">(object, <span class="optional">color</span>, <span class="optional">filled</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2015-10-15 11:06:38 +00:00
<p>Renders a Rectangle.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
2013-11-28 15:57:09 +00:00
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>object</code></td>
2013-11-28 15:57:09 +00:00
<td class="type">
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>
|
2013-11-28 15:57:09 +00:00
2015-10-15 11:06:38 +00:00
<span class="param-type">object</span>
2013-11-28 15:57:09 +00:00
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The geometry object to render.</p></td>
2013-11-28 15:57:09 +00:00
</tr>
<tr>
<td class="name"><code>color</code></td>
2013-11-28 15:57:09 +00:00
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>Color of the debug info to be rendered (format is css color string).</p></td>
</tr>
<tr>
<td class="name"><code>filled</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
2013-11-28 15:57:09 +00:00
<td class="default">
true
2013-11-28 15:57:09 +00:00
</td>
<td class="description last"><p>Render the objected as a filled (default, true) or a stroked (false)</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-618">line 618</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="inputInfo"><span class="type-signature"></span>inputInfo<span class="signature">(x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Render debug information about the Input object.</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>x</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>X position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>y</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>Y position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgb(255,255,255)'
</td>
<td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-406">line 406</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="key"><span class="type-signature"></span>key<span class="signature">(key, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Renders Phaser.Key object information.</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>key</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Key.html">Phaser.Key</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The Key to render the information for.</p></td>
</tr>
<tr>
<td class="name"><code>x</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>X position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>y</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>Y position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgb(255,255,255)'
</td>
<td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-385">line 385</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="line"><span class="type-signature">&lt;internal> </span>line<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Internal method that outputs a single line of text split over as many columns as needed, one per parameter.</p>
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<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>
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-199">line 199</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="lineInfo"><span class="type-signature"></span>lineInfo<span class="signature">(line, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Renders Line information in the given color.</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>line</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Line.html">Phaser.Line</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The Line to display the data for.</p></td>
</tr>
<tr>
<td class="name"><code>x</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>X position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>y</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>Y position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgb(255,255,255)'
</td>
<td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-514">line 514</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="pixel"><span class="type-signature"></span>pixel<span class="signature">(x, y, <span class="optional">color</span>, <span class="optional">size</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Renders a single pixel at the given size.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
2014-02-05 06:29:17 +00:00
<th>Default</th>
2014-02-05 06:29:17 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
2014-02-05 06:29:17 +00:00
<td class="type">
<span class="param-type">number</span>
2014-02-05 06:29:17 +00:00
</td>
<td class="attributes">
</td>
2014-02-05 06:29:17 +00:00
<td class="default">
</td>
<td class="description last"><p>X position of the pixel to be rendered.</p></td>
2014-02-05 06:29:17 +00:00
</tr>
<tr>
<td class="name"><code>y</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>Y position of the pixel to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
2014-02-05 06:29:17 +00:00
<span class="param-type">string</span>
2014-02-05 06:29:17 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>Color of the pixel (format is css color string).</p></td>
</tr>
<tr>
<td class="name"><code>size</code></td>
<td class="type">
2014-02-05 06:29:17 +00:00
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
2014-02-05 06:29:17 +00:00
<td class="default">
2
</td>
<td class="description last"><p>The 'size' to render the pixel at.</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-533">line 533</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="pointer"><span class="type-signature"></span>pointer<span class="signature">(pointer, <span class="optional">hideIfUp</span>, <span class="optional">downColor</span>, <span class="optional">upColor</span>, <span class="optional">color</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Renders the Pointer.circle object onto the stage in green if down or red if up along with debug text.</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>pointer</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The Pointer you wish to display.</p></td>
</tr>
<tr>
<td class="name"><code>hideIfUp</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>Doesn't render the circle if the pointer is up.</p></td>
</tr>
<tr>
<td class="name"><code>downColor</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgba(0,255,0,0.5)'
</td>
<td class="description last"><p>The color the circle is rendered in if down.</p></td>
</tr>
<tr>
<td class="name"><code>upColor</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgba(255,0,0,0.5)'
</td>
<td class="description last"><p>The color the circle is rendered in if up (and hideIfUp is false).</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgb(255,255,255)'
</td>
<td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-304">line 304</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="preUpdate"><span class="type-signature"></span>preUpdate<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Internal method that clears the canvas (if a Sprite) ready for a new debug session.</p>
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-117">line 117</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="quadTree"><span class="type-signature"></span>quadTree<span class="signature">(quadtree, color)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Visually renders a QuadTree to the display.</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>quadtree</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.QuadTree.html">Phaser.QuadTree</a></span>
</td>
<td class="description last"><p>The quadtree to render.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The color of the lines in the quadtree.</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-680">line 680</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-09-09 14:36:56 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2014-09-09 14:36:56 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="reset"><span class="type-signature"></span>reset<span class="signature">()</span><span class="type-signature"></span></h4>
2014-09-09 14:36:56 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-09-09 14:36:56 +00:00
<div class="description">
<p>Clears the Debug canvas.</p>
</div>
2014-11-15 20:01:46 +00:00
2014-09-09 14:36:56 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-135">line 135</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-09-09 14:36:56 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2014-09-09 14:36:56 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="ropeSegments"><span class="type-signature"></span>ropeSegments<span class="signature">(rope, <span class="optional">color</span>, <span class="optional">filled</span>)</span><span class="type-signature"></span></h4>
2014-09-09 14:36:56 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-09-09 14:36:56 +00:00
<div class="description">
2015-07-22 14:31:30 +00:00
<p>Renders the Rope's segments. Note: This is really expensive as it has to calculate new segments every time you call it</p>
2014-09-09 14:36:56 +00:00
</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>rope</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Rope.html">Phaser.Rope</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The rope to display the segments of.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>Color of the debug info to be rendered (format is css color string).</p></td>
</tr>
<tr>
<td class="name"><code>filled</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>Render the rectangle as a fillRect (default, true) or a strokeRect (false)</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
2014-09-09 14:36:56 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-445">line 445</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="soundInfo"><span class="type-signature"></span>soundInfo<span class="signature">(sound, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Render Sound information, including decoded state, duration, volume and more.</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>sound</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The sound object to debug.</p></td>
</tr>
<tr>
<td class="name"><code>x</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>X position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>y</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>Y position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgb(255,255,255)'
</td>
<td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-227">line 227</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="spriteBounds"><span class="type-signature"></span>spriteBounds<span class="signature">(sprite, <span class="optional">color</span>, <span class="optional">filled</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Renders the Sprites bounds. Note: This is really expensive as it has to calculate the bounds every time you call it!</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 to display the bounds of.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>Color of the debug info to be rendered (format is css color string).</p></td>
</tr>
<tr>
<td class="name"><code>filled</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>Render the rectangle as a fillRect (default, true) or a strokeRect (false)</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-426">line 426</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="spriteCoords"><span class="type-signature"></span>spriteCoords<span class="signature">(sprite, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Renders the sprite coordinates in local, positional and world space.</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">
2013-10-25 15:54:40 +00:00
<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 to display the coordinates for.</p></td>
</tr>
<tr>
<td class="name"><code>x</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>X position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>y</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>Y position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgb(255,255,255)'
</td>
<td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-488">line 488</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="spriteInfo"><span class="type-signature"></span>spriteInfo<span class="signature">(sprite, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Render debug infos (including name, bounds info, position and some other properties) about 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">
2013-10-25 15:54:40 +00:00
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The Sprite to display the information of.</p></td>
</tr>
<tr>
<td class="name"><code>x</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>X position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>y</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>Y position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgb(255,255,255)'
</td>
<td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-465">line 465</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="spriteInputInfo"><span class="type-signature"></span>spriteInputInfo<span class="signature">(sprite, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Render Sprite Input Debug information.</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">
2013-10-25 15:54:40 +00:00
<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 to display the input data for.</p></td>
</tr>
<tr>
<td class="name"><code>x</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>X position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>y</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>Y position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgb(255,255,255)'
</td>
<td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-364">line 364</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="start"><span class="type-signature">&lt;internal> </span>start<span class="signature">(<span class="optional">x</span>, <span class="optional">y</span>, <span class="optional">color</span>, <span class="optional">columnWidth</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Internal method that resets and starts the debug output values.</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>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>The X value the debug info will start from.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>The Y value the debug info will start from.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgb(255,255,255)'
</td>
<td class="description last"><p>The color the debug text will drawn in.</p></td>
</tr>
<tr>
<td class="name"><code>columnWidth</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>The spacing between columns.</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<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>
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-154">line 154</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="stop"><span class="type-signature">&lt;internal> </span>stop<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Internal method that stops the debug output.</p>
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<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>
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-187">line 187</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="text"><span class="type-signature"></span>text<span class="signature">(text, x, y, <span class="optional">color</span>, <span class="optional">font</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Render a string of text.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
2014-02-05 06:29:17 +00:00
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
2014-02-05 06:29:17 +00:00
<td class="attributes">
</td>
<td class="description last"><p>The line of text to draw.</p></td>
</tr>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
2014-02-05 06:29:17 +00:00
<span class="param-type">number</span>
</td>
<td class="attributes">
2014-02-05 06:29:17 +00:00
</td>
<td class="description last"><p>X position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
2014-02-05 06:29:17 +00:00
<td class="attributes">
</td>
<td class="description last"><p>Y position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
2014-02-05 06:29:17 +00:00
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>Color of the debug info to be rendered (format is css color string).</p></td>
2014-02-05 06:29:17 +00:00
</tr>
<tr>
<td class="name"><code>font</code></td>
2014-02-05 06:29:17 +00:00
<td class="type">
<span class="param-type">string</span>
2014-02-05 06:29:17 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The font of text to draw.</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-649">line 649</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-04-29 14:39:02 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="timer"><span class="type-signature"></span>timer<span class="signature">(timer, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4>
2014-04-29 14:39:02 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
<div class="description">
<p>Render Timer information.</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>timer</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Timer.html">Phaser.Timer</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The Phaser.Timer to show the debug information for.</p></td>
</tr>
<tr>
<td class="name"><code>x</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>X position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>y</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>Y position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgb(255,255,255)'
</td>
<td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_utils_Debug.js.html">utils/Debug.js</a>, <a href="src_utils_Debug.js.html#sunlight-1-line-285">line 285</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
2015-03-23 23:46:30 +00:00
Phaser Copyright © 2012-2015 Photon Storm Ltd.
</span>
<br />
<span class="jsdoc-message">
2015-08-24 14:43:45 +00:00
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a>
2015-10-15 11:06:38 +00:00
on Thu Oct 15 2015 12:05:07 GMT+0100 (GMT Daylight Time) 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( {
2014-04-10 22:13:43 +00:00
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>