phaser/docs/PIXI.Graphics.html

8482 lines
135 KiB
HTML
Raw Normal View History

2014-11-15 20:01:46 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: Graphics</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/default.css">
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
2014-11-25 00:23:44 +00:00
2014-11-15 20:01:46 +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>
2014-11-15 20:01:46 +00:00
<div class="navbar-inner">
2014-11-25 00:23:44 +00:00
<a class="brand" href="index.html">Phaser API</a>
2014-11-15 20:01:46 +00:00
<ul class="nav">
2014-11-25 00:23:44 +00:00
2014-11-15 20:01:46 +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 ">
<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 ">
<li class="class-depth-1">
<a href="Phaser.Animation.html">Animation</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationManager.html">AnimationManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
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>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Button.html">Button</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
</li>
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-11-15 20:01:46 +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>
<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-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Events.html">Events</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Filter.html">Filter</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexGrid.html">FlexGrid</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexLayer.html">FlexLayer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Game.html">Game</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Group.html">Group</a>
</li>
<li class="class-depth-1">
<a href="Phaser.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-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.Input.html">Input</a>
</li>
<li class="class-depth-1">
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Key.html">Key</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Line.html">Line</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Loader.html">Loader</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LoaderParser.html">LoaderParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Math.html">Math</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.Matrix.html">Matrix</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.Mouse.html">Mouse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Net.html">Net</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Physics.html">Physics</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
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-11-15 20:01:46 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Plugin.html">Plugin</a>
</li>
<li class="class-depth-1">
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Point.html">Point</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Pointer.html">Pointer</a>
</li>
2015-10-15 11:06:38 +00:00
<li class="class-depth-1">
<a href="Phaser.PointerMode.html">PointerMode</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.RoundedRectangle.html">RoundedRectangle</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sound.html">Sound</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="Phaser.State.html">State</a>
</li>
<li class="class-depth-1">
<a href="Phaser.StateManager.html">StateManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Text.html">Text</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tile.html">Tile</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tileset.html">Tileset</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Time.html">Time</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Timer.html">Timer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Touch.html">Touch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenData.html">TweenData</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
<li class="class-depth-1">
2015-07-22 14:31:30 +00:00
<a href="Phaser.Video.html">Video</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="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>
2016-02-08 17:01:36 +00:00
<li class="class-depth-1">
<a href="PIXI.EarCut.html">EarCut</a>
</li>
2014-11-15 20:01:46 +00:00
<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>
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#DOWN">DOWN</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#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>
</li>
<li class="class-depth-0">
<a href="global.html#GROUP">GROUP</a>
</li>
<li class="class-depth-0">
<a href="global.html#HEADLESS">HEADLESS</a>
</li>
<li class="class-depth-0">
<a href="global.html#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>
2016-02-08 17:01:36 +00:00
<li class="class-depth-0">
<a href="global.html#PENDING_ATLAS">PENDING_ATLAS</a>
</li>
2015-07-22 14:31:30 +00:00
<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>
</li>
<li class="class-depth-0">
<a href="global.html#TEXT">TEXT</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILEMAP">TILEMAP</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILEMAPLAYER">TILEMAPLAYER</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILESPRITE">TILESPRITE</a>
</li>
<li class="class-depth-0">
<a href="global.html#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>
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#WEBGL">WEBGL</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#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: Graphics</h1>-->
2014-11-15 20:01:46 +00:00
<section>
<header>
<h2>
<span class="ancestors"><a href="PIXI.html">PIXI</a>.</span>
Graphics
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name "
id="Graphics"><span class="type-signature"></span>new Graphics<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The Graphics class contains methods used to draw primitive shapes such as lines, circles and rectangles to the display, and color and fill them.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-5">line 5</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="PIXI.DisplayObjectContainer.html">PIXI.DisplayObjectContainer</a></li>
</ul>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name "
id="alpha"><span class="type-signature"></span>alpha<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The opacity of the object.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#alpha">PIXI.DisplayObject#alpha</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-46">line 46</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="blendMode"><span class="type-signature"></span>blendMode<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The blend mode to be applied to the graphic shape. Apply a value of PIXI.blendModes.NORMAL to reset the blend mode.</p>
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>PIXI.blendModes.NORMAL;</li></ul></dd>
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-61">line 61</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="boundsPadding"><span class="type-signature"></span>boundsPadding<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The bounds' padding used for bounds calculation.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-96">line 96</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2014-12-03 10:39:11 +00:00
id="children"><span class="type-signature">&lt;readonly> </span>children<span class="type-signature"> :Array.&lt;<a href="global.html#DisplayObject">DisplayObject</a>></span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
<p>[read-only] The array of children of this container.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
2014-12-03 10:39:11 +00:00
<span class="param-type">Array.&lt;<a href="global.html#DisplayObject">DisplayObject</a>></span>
2014-11-15 20:01:46 +00:00
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#children">PIXI.DisplayObjectContainer#children</a>
</li></dd>
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-17">line 17</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="fillAlpha"><span class="type-signature"></span>fillAlpha<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The alpha value used when filling the Graphics object.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-18">line 18</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-03-23 23:46:30 +00:00
id="filterArea"><span class="type-signature"></span>filterArea<span class="type-signature"> :Rectangle</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
<p>The area the filter is applied to like the hitArea this is used as more of an optimisation
rather than figuring out the dimensions of the displayObject each frame you can set this rectangle</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#filterArea">PIXI.DisplayObject#filterArea</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-164">line 164</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="filters"><span class="type-signature"></span>filters<span class="type-signature"> :Array.&lt;Filter></span></h4>
</dt>
<dd>
<div class="description">
<p>Sets the filters for the displayObject.
2015-08-24 14:43:45 +00:00
IMPORTANT: This is a webGL only feature and will be ignored by the Canvas renderer.</p>
<p>To remove filters simply set this property to 'null'.</p>
<p>You cannot have a filter and a multiply blend mode active at the same time. Setting a filter will reset
this objects blend mode to NORMAL.</p>
2014-11-15 20:01:46 +00:00
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.&lt;Filter></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#filters">PIXI.DisplayObject#filters</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-307">line 307</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="height"><span class="type-signature"></span>height<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#height">PIXI.DisplayObjectContainer#height</a>
</li></dd>
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-61">line 61</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-03-23 23:46:30 +00:00
id="hitArea"><span class="type-signature"></span>hitArea<span class="type-signature"> :Rectangle|Circle|Ellipse|Polygon</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
<p>This is the defined area that will pick up mouse / touch events. It is null by default.
Setting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)</p>
</div>
<h5>Type:</h5>
<ul>
<li>
2015-03-23 23:46:30 +00:00
<span class="param-type">Rectangle</span>
2014-11-15 20:01:46 +00:00
|
2015-03-23 23:46:30 +00:00
<span class="param-type">Circle</span>
2014-11-15 20:01:46 +00:00
|
2015-03-23 23:46:30 +00:00
<span class="param-type">Ellipse</span>
2014-11-15 20:01:46 +00:00
|
2015-03-23 23:46:30 +00:00
<span class="param-type">Polygon</span>
2014-11-15 20:01:46 +00:00
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#hitArea">PIXI.DisplayObject#hitArea</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-62">line 62</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="isMask"><span class="type-signature"></span>isMask<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Whether this shape is being used as a mask.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-88">line 88</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="lineColor"><span class="type-signature"></span>lineColor<span class="type-signature"> :String</span></h4>
</dt>
<dd>
<div class="description">
<p>The color of any lines drawn.</p>
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-34">line 34</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="lineWidth"><span class="type-signature"></span>lineWidth<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The width (thickness) of any lines drawn.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-26">line 26</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="mask"><span class="type-signature"></span>mask<span class="type-signature"> :<a href="PIXI.Graphics.html">PIXI.Graphics</a></span></h4>
</dt>
<dd>
<div class="description">
<p>Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.
In PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.
To remove a mask, set this property to null.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#mask">PIXI.DisplayObject#mask</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-282">line 282</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="parent"><span class="type-signature">&lt;readonly> </span>parent<span class="type-signature"> :<a href="PIXI.DisplayObjectContainer.html">PIXI.DisplayObjectContainer</a></span></h4>
</dt>
<dd>
<div class="description">
<p>[read-only] The display object container that contains this display object.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#parent">PIXI.DisplayObject#parent</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-79">line 79</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-03-23 23:46:30 +00:00
id="pivot"><span class="type-signature"></span>pivot<span class="type-signature"> :Point</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
<p>The pivot point of the displayObject that it rotates around</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#pivot">PIXI.DisplayObject#pivot</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-30">line 30</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-03-23 23:46:30 +00:00
id="position"><span class="type-signature"></span>position<span class="type-signature"> :Point</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
<p>The coordinate of the object relative to the local coordinates of the parent.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#position">PIXI.DisplayObject#position</a>
</li></dd>
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-14">line 14</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="renderable"><span class="type-signature"></span>renderable<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Can this object be rendered</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#renderable">PIXI.DisplayObject#renderable</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-71">line 71</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="rotation"><span class="type-signature"></span>rotation<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The rotation of the object in radians.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#rotation">PIXI.DisplayObject#rotation</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-38">line 38</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-03-23 23:46:30 +00:00
id="scale"><span class="type-signature"></span>scale<span class="type-signature"> :Point</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
<p>The scale factor of the object.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#scale">PIXI.DisplayObject#scale</a>
</li></dd>
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-22">line 22</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-10-15 11:06:38 +00:00
id="stage"><span class="type-signature">&lt;readonly> </span>stage<span class="type-signature"> :Stage</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
<p>[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#stage">PIXI.DisplayObject#stage</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-88">line 88</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="tint"><span class="type-signature"></span>tint<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The tint applied to the graphic shape. This is a hex value. Apply a value of 0xFFFFFF to reset the tint.</p>
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0xFFFFFF</li></ul></dd>
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-52">line 52</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="visible"><span class="type-signature"></span>visible<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>The visibility of the object.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#visible">PIXI.DisplayObject#visible</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-54">line 54</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="width"><span class="type-signature"></span>width<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#width">PIXI.DisplayObjectContainer#width</a>
</li></dd>
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-32">line 32</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="worldAlpha"><span class="type-signature">&lt;readonly> </span>worldAlpha<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>[read-only] The multiplied alpha of the displayObject</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#worldAlpha">PIXI.DisplayObject#worldAlpha</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-97">line 97</a>
2014-11-15 20:01:46 +00:00
</dt>
2015-07-22 14:31:30 +00:00
</dl>
</dd>
<dt>
<h4 class="name "
id="worldPosition"><span class="type-signature">&lt;readonly> </span>worldPosition<span class="type-signature"> :Point</span></h4>
</dt>
<dd>
<div class="description">
<p>The position of the Display Object based on the world transform.
This value is updated at the end of updateTransform and takes all parent transforms into account.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#worldPosition">PIXI.DisplayObject#worldPosition</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-116">line 116</a>
2015-07-22 14:31:30 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="worldRotation"><span class="type-signature">&lt;readonly> </span>worldRotation<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The rotation of the Display Object, in radians, based on the world transform.
This value is updated at the end of updateTransform and takes all parent transforms into account.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#worldRotation">PIXI.DisplayObject#worldRotation</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-136">line 136</a>
2015-07-22 14:31:30 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="worldScale"><span class="type-signature">&lt;readonly> </span>worldScale<span class="type-signature"> :Point</span></h4>
</dt>
<dd>
<div class="description">
<p>The scale of the Display Object based on the world transform.
This value is updated at the end of updateTransform and takes all parent transforms into account.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#worldScale">PIXI.DisplayObject#worldScale</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-126">line 126</a>
2015-07-22 14:31:30 +00:00
</dt>
2014-11-15 20:01:46 +00:00
</dl>
</dd>
<dt>
<h4 class="name "
id="worldVisible"><span class="type-signature"></span>worldVisible<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>[read-only] Indicates if the sprite is globally visible.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#worldVisible">PIXI.DisplayObject#worldVisible</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-258">line 258</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="x"><span class="type-signature"></span>x<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The position of the displayObject on the x axis relative to the local coordinates of the parent.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#x">PIXI.DisplayObject#x</a>
</li></dd>
<dt class="tag-source">Source -
2016-02-17 13:27:09 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-723">line 723</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="y"><span class="type-signature"></span>y<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The position of the displayObject on the y axis relative to the local coordinates of the parent.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#y">PIXI.DisplayObject#y</a>
</li></dd>
<dt class="tag-source">Source -
2016-02-17 13:27:09 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-741">line 741</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name "
id="addChild"><span class="type-signature"></span>addChild<span class="signature">(child)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a child to the container.</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>child</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="description last"><p>The DisplayObject to add to the container</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The child that was added.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#addChild">PIXI.DisplayObjectContainer#addChild</a>
</li></dd>
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-91">line 91</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addChildAt"><span class="type-signature"></span>addChildAt<span class="signature">(child, index)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown</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>child</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="description last"><p>The child to add</p></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The index to place the child in</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The child that was added.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#addChildAt">PIXI.DisplayObjectContainer#addChildAt</a>
</li></dd>
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-103">line 103</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2016-02-08 17:01:36 +00:00
id="arc"><span class="type-signature"></span>arc<span class="signature">(cx, cy, radius, startAngle, endAngle, anticlockwise, segments)</span><span class="type-signature"> &rarr; {<a href="PIXI.Graphics.html">PIXI.Graphics</a>}</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
<p>The arc method creates an arc/curve (used to create circles, or parts of circles).</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>cx</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The x-coordinate of the center of the circle</p></td>
</tr>
<tr>
<td class="name"><code>cy</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The y-coordinate of the center of the circle</p></td>
</tr>
<tr>
<td class="name"><code>radius</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The radius of the circle</p></td>
</tr>
<tr>
<td class="name"><code>startAngle</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The starting angle, in radians (0 is at the 3 o'clock position of the arc's circle)</p></td>
</tr>
<tr>
<td class="name"><code>endAngle</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The ending angle, in radians</p></td>
</tr>
<tr>
<td class="name"><code>anticlockwise</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last"><p>Optional. Specifies whether the drawing should be counterclockwise or clockwise. False is default, and indicates clockwise, while true indicates counter-clockwise.</p></td>
</tr>
2016-02-08 17:01:36 +00:00
<tr>
<td class="name"><code>segments</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Optional. The number of segments to use when calculating the arc. The default is 40. If you need more fidelity use a higher number.</p></td>
</tr>
2014-11-15 20:01:46 +00:00
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Graphics.html">PIXI.Graphics</a></span>
-
</div>
<div class="returns-desc param-desc">
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2015-03-26 02:38:46 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-391">line 391</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="beginFill"><span class="type-signature"></span>beginFill<span class="signature">(color, alpha)</span><span class="type-signature"> &rarr; {<a href="PIXI.Graphics.html">PIXI.Graphics</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Specifies a simple one-color fill that subsequent calls to other Graphics methods
(such as lineTo() or drawCircle()) use when drawing.</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>color</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>the color of the fill</p></td>
</tr>
<tr>
<td class="name"><code>alpha</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>the alpha of the fill</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Graphics.html">PIXI.Graphics</a></span>
-
</div>
<div class="returns-desc param-desc">
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-02-08 17:01:36 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-476">line 476</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="bezierCurveTo"><span class="type-signature"></span>bezierCurveTo<span class="signature">(cpX, cpY, cpX2, cpY2, toX, toY)</span><span class="type-signature"> &rarr; {<a href="PIXI.Graphics.html">PIXI.Graphics</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Calculate the points for a bezier curve and then draws it.</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>cpX</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Control point x</p></td>
</tr>
<tr>
<td class="name"><code>cpY</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Control point y</p></td>
</tr>
<tr>
<td class="name"><code>cpX2</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Second Control point x</p></td>
</tr>
<tr>
<td class="name"><code>cpY2</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Second Control point y</p></td>
</tr>
<tr>
<td class="name"><code>toX</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Destination point x</p></td>
</tr>
<tr>
<td class="name"><code>toY</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Destination point y</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Graphics.html">PIXI.Graphics</a></span>
-
</div>
<div class="returns-desc param-desc">
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2015-03-26 02:38:46 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-264">line 264</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="clear"><span class="type-signature"></span>clear<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="PIXI.Graphics.html">PIXI.Graphics</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Graphics.html">PIXI.Graphics</a></span>
-
</div>
<div class="returns-desc param-desc">
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-02-08 17:01:36 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-618">line 618</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-03-23 23:46:30 +00:00
id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
2015-03-23 23:46:30 +00:00
<p>Destroy this DisplayObject.
Removes all references to transformCallbacks, its parent, the stage, filters, bounds, mask and cached Sprites.</p>
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#destroy">PIXI.DisplayObject#destroy</a>
</li></dd>
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-223">line 223</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-03-23 23:46:30 +00:00
id="destroyCachedSprite"><span class="type-signature"></span>destroyCachedSprite<span class="signature">()</span><span class="type-signature"></span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
2015-03-23 23:46:30 +00:00
<p>Destroys a previous cached sprite.</p>
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-02-17 13:27:09 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-1129">line 1129</a>
2015-07-22 14:31:30 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="drawCircle"><span class="type-signature"></span>drawCircle<span class="signature">(x, y, diameter)</span><span class="type-signature"> &rarr; {<a href="PIXI.Graphics.html">PIXI.Graphics</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Draws a circle.</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>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The X coordinate of the center of the circle</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The Y coordinate of the center of the circle</p></td>
</tr>
<tr>
<td class="name"><code>diameter</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The diameter of the circle</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Graphics.html">PIXI.Graphics</a></span>
-
</div>
<div class="returns-desc param-desc">
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-02-08 17:01:36 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-550">line 550</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="drawEllipse"><span class="type-signature"></span>drawEllipse<span class="signature">(x, y, width, height)</span><span class="type-signature"> &rarr; {<a href="PIXI.Graphics.html">PIXI.Graphics</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Draws an ellipse.</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>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The X coordinate of the center of the ellipse</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The Y coordinate of the center of the ellipse</p></td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The half width of the ellipse</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The half height of the ellipse</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Graphics.html">PIXI.Graphics</a></span>
-
</div>
<div class="returns-desc param-desc">
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-02-08 17:01:36 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-566">line 566</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="drawPolygon"><span class="type-signature"></span>drawPolygon<span class="signature">(path)</span><span class="type-signature"> &rarr; {<a href="PIXI.Graphics.html">PIXI.Graphics</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Draws a polygon using the given path.</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>path</code></td>
<td class="type">
<span class="param-type">Array</span>
2015-07-22 14:31:30 +00:00
|
<span class="param-type">PhaserPolygon</span>
2014-11-15 20:01:46 +00:00
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>The path data used to construct the polygon. Can either be an array of points or a Phaser.Polygon object.</p></td>
2014-11-15 20:01:46 +00:00
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Graphics.html">PIXI.Graphics</a></span>
-
</div>
<div class="returns-desc param-desc">
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-02-08 17:01:36 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-583">line 583</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="drawRect"><span class="type-signature"></span>drawRect<span class="signature">(x, y, width, height)</span><span class="type-signature"> &rarr; {<a href="PIXI.Graphics.html">PIXI.Graphics</a>}</span></h4>
</dt>
<dd>
<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>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The X coord of the top-left of the rectangle</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The Y coord of the top-left of the rectangle</p></td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The width of the rectangle</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The height of the rectangle</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Graphics.html">PIXI.Graphics</a></span>
-
</div>
<div class="returns-desc param-desc">
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-02-08 17:01:36 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-519">line 519</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="drawRoundedRect"><span class="type-signature"></span>drawRoundedRect<span class="signature">(x, y, width, height, radius)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The X coord of the top-left of the rectangle</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The Y coord of the top-left of the rectangle</p></td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The width of the rectangle</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The height of the rectangle</p></td>
</tr>
<tr>
<td class="name"><code>radius</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>Radius of the rectangle corners. In WebGL this must be a value between 0 and 9.</p></td>
2014-11-15 20:01:46 +00:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
2016-02-08 17:01:36 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-535">line 535</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="drawShape"><span class="type-signature"></span>drawShape<span class="signature">(shape)</span><span class="type-signature"> &rarr; {<a href="PIXI.GraphicsData.html">PIXI.GraphicsData</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.</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>shape</code></td>
<td class="type">
2015-03-23 23:46:30 +00:00
<span class="param-type">Circle</span>
2014-11-15 20:01:46 +00:00
|
2015-03-23 23:46:30 +00:00
<span class="param-type">Rectangle</span>
2014-11-15 20:01:46 +00:00
|
2015-03-23 23:46:30 +00:00
<span class="param-type">Ellipse</span>
2014-11-15 20:01:46 +00:00
|
<span class="param-type">Line</span>
|
2015-03-23 23:46:30 +00:00
<span class="param-type">Polygon</span>
2014-11-15 20:01:46 +00:00
</td>
<td class="description last"><p>The Shape object to draw.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.GraphicsData.html">PIXI.GraphicsData</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The generated GraphicsData object.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-02-17 13:27:09 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-1140">line 1140</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="endFill"><span class="type-signature"></span>endFill<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="PIXI.Graphics.html">PIXI.Graphics</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Graphics.html">PIXI.Graphics</a></span>
-
</div>
<div class="returns-desc param-desc">
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-02-08 17:01:36 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-504">line 504</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2016-02-17 13:27:09 +00:00
id="generateTexture"><span class="type-signature"></span>generateTexture<span class="signature">(<span class="optional">resolution</span>, <span class="optional">scaleMode</span>, <span class="optional">padding</span>)</span><span class="type-signature"> &rarr; {<a href="PIXI.Texture.html">PIXI.Texture</a>}</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
<p>Useful function that returns a texture of the graphics object that can then be used to create sprites
This can be quite useful if your geometry is complicated and needs to be reused multiple times.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
2016-02-17 13:27:09 +00:00
<th>Argument</th>
2014-11-15 20:01:46 +00:00
2016-02-17 13:27:09 +00:00
<th>Default</th>
2014-11-15 20:01:46 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>resolution</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
2016-02-17 13:27:09 +00:00
<td class="attributes">
&lt;optional><br>
2014-11-15 20:01:46 +00:00
2016-02-17 13:27:09 +00:00
</td>
<td class="default">
1
</td>
2014-11-15 20:01:46 +00:00
<td class="description last"><p>The resolution of the texture being generated</p></td>
</tr>
<tr>
<td class="name"><code>scaleMode</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
2016-02-17 13:27:09 +00:00
<td class="attributes">
&lt;optional><br>
</td>
2014-11-15 20:01:46 +00:00
2016-02-17 13:27:09 +00:00
<td class="default">
0
</td>
2014-11-15 20:01:46 +00:00
<td class="description last"><p>Should be one of the PIXI.scaleMode consts</p></td>
</tr>
2016-02-17 13:27:09 +00:00
<tr>
<td class="name"><code>padding</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>Add optional extra padding to the generated texture (default 0)</p></td>
</tr>
2014-11-15 20:01:46 +00:00
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Texture.html">PIXI.Texture</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>a texture of the graphics object</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-02-08 17:01:36 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-636">line 636</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-03-23 23:46:30 +00:00
id="getBounds"><span class="type-signature"></span>getBounds<span class="signature">()</span><span class="type-signature"> &rarr; {Rectangle}</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
<p>Retrieves the bounds of the graphic shape as a rectangle object</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
2015-03-23 23:46:30 +00:00
<span class="param-type">Rectangle</span>
2014-11-15 20:01:46 +00:00
-
</div>
<div class="returns-desc param-desc">
<p>the rectangular bounding area</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-02-17 13:27:09 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-830">line 830</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getChildAt"><span class="type-signature"></span>getChildAt<span class="signature">(index)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the child at the specified index</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>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The index to get the child from</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The child at the given index, if any.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#getChildAt">PIXI.DisplayObjectContainer#getChildAt</a>
</li></dd>
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-194">line 194</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getChildIndex"><span class="type-signature"></span>getChildIndex<span class="signature">(child)</span><span class="type-signature"> &rarr; {Number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the index position of a child DisplayObject instance</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>child</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="description last"><p>The DisplayObject instance to identify</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">Number</span>
-
</div>
<div class="returns-desc param-desc">
<p>The index position of the child display object to identify</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#getChildIndex">PIXI.DisplayObjectContainer#getChildIndex</a>
</li></dd>
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-159">line 159</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-03-23 23:46:30 +00:00
id="getLocalBounds"><span class="type-signature"></span>getLocalBounds<span class="signature">()</span><span class="type-signature"> &rarr; {Rectangle}</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
<p>Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
2015-03-23 23:46:30 +00:00
<span class="param-type">Rectangle</span>
2014-11-15 20:01:46 +00:00
-
</div>
<div class="returns-desc param-desc">
<p>The rectangular bounding area</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#getLocalBounds">PIXI.DisplayObjectContainer#getLocalBounds</a>
</li></dd>
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-367">line 367</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="lineStyle"><span class="type-signature"></span>lineStyle<span class="signature">(lineWidth, color, alpha)</span><span class="type-signature"> &rarr; {<a href="PIXI.Graphics.html">PIXI.Graphics</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Specifies the line style used for subsequent calls to Graphics methods such as the lineTo() method or the drawCircle() method.</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>lineWidth</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>width of the line to draw, will update the objects stored style</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>color of the line to draw, will update the objects stored style</p></td>
</tr>
<tr>
<td class="name"><code>alpha</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>alpha of the line to draw, will update the objects stored style</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Graphics.html">PIXI.Graphics</a></span>
-
</div>
<div class="returns-desc param-desc">
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-139">line 139</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="lineTo"><span class="type-signature"></span>lineTo<span class="signature">(x, y)</span><span class="type-signature"> &rarr; {<a href="PIXI.Graphics.html">PIXI.Graphics</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Draws a line using the current line style from the current drawing position to (x, y);
The current drawing position is then set to (x, y).</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>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>the X coordinate to draw to</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>the Y coordinate to draw to</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Graphics.html">PIXI.Graphics</a></span>
-
</div>
<div class="returns-desc param-desc">
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-188">line 188</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2014-12-03 10:39:11 +00:00
id="moveTo"><span class="type-signature"></span>moveTo<span class="signature">(x, y)</span><span class="type-signature"> &rarr; {<a href="PIXI.Graphics.html">PIXI.Graphics</a>}</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
2014-12-03 10:39:11 +00:00
<p>Moves the current drawing position to x, y.</p>
2014-11-15 20:01:46 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2014-12-03 10:39:11 +00:00
<td class="name"><code>x</code></td>
2014-11-15 20:01:46 +00:00
<td class="type">
2014-12-03 10:39:11 +00:00
<span class="param-type">Number</span>
2014-11-15 20:01:46 +00:00
</td>
2014-12-03 10:39:11 +00:00
<td class="description last"><p>the X coordinate to move to</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>the Y coordinate to move to</p></td>
2014-11-15 20:01:46 +00:00
</tr>
</tbody>
</table>
2014-12-03 10:39:11 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Graphics.html">PIXI.Graphics</a></span>
-
</div>
<div class="returns-desc param-desc">
</div>
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-173">line 173</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="preUpdate"><span class="type-signature"></span>preUpdate<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Empty, to be overridden by classes that require it.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#preUpdate">PIXI.DisplayObject#preUpdate</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-533">line 533</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2014-12-03 10:39:11 +00:00
id="quadraticCurveTo"><span class="type-signature"></span>quadraticCurveTo<span class="signature">(cpX, cpY, toX, toY)</span><span class="type-signature"> &rarr; {<a href="PIXI.Graphics.html">PIXI.Graphics</a>}</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
2014-12-03 10:39:11 +00:00
<p>Calculate the points for a quadratic bezier curve and then draws it.
2015-03-23 23:46:30 +00:00
Based on: https://stackoverflow.com/questions/785097/how-do-i-implement-a-bezier-curve-in-c</p>
2014-11-15 20:01:46 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2014-12-03 10:39:11 +00:00
<td class="name"><code>cpX</code></td>
2014-11-15 20:01:46 +00:00
<td class="type">
2014-12-03 10:39:11 +00:00
<span class="param-type">Number</span>
2014-11-15 20:01:46 +00:00
</td>
2014-12-03 10:39:11 +00:00
<td class="description last"><p>Control point x</p></td>
</tr>
<tr>
<td class="name"><code>cpY</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Control point y</p></td>
</tr>
<tr>
<td class="name"><code>toX</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Destination point x</p></td>
</tr>
<tr>
<td class="name"><code>toY</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>Destination point y</p></td>
2014-11-15 20:01:46 +00:00
</tr>
</tbody>
</table>
2014-12-03 10:39:11 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Graphics.html">PIXI.Graphics</a></span>
-
</div>
<div class="returns-desc param-desc">
</div>
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-210">line 210</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2014-12-03 10:39:11 +00:00
id="removeChild"><span class="type-signature"></span>removeChild<span class="signature">(child)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
2014-12-03 10:39:11 +00:00
<p>Removes a child from the container.</p>
2014-11-15 20:01:46 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2014-12-03 10:39:11 +00:00
<td class="name"><code>child</code></td>
2014-11-15 20:01:46 +00:00
<td class="type">
2014-12-03 10:39:11 +00:00
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
2014-11-15 20:01:46 +00:00
</td>
2014-12-03 10:39:11 +00:00
<td class="description last"><p>The DisplayObject to remove</p></td>
2014-11-15 20:01:46 +00:00
</tr>
</tbody>
</table>
2014-12-03 10:39:11 +00:00
<h5>Returns:</h5>
<div class="returns">
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
-
</div>
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
<div class="returns-desc param-desc">
<p>The child that was removed.</p>
</div>
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
2014-12-03 10:39:11 +00:00
<a href="PIXI.DisplayObjectContainer.html#removeChild">PIXI.DisplayObjectContainer#removeChild</a>
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-211">line 211</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2014-12-03 10:39:11 +00:00
id="removeChildAt"><span class="type-signature"></span>removeChildAt<span class="signature">(index)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
2014-12-03 10:39:11 +00:00
<p>Removes a child from the specified index position.</p>
2014-11-15 20:01:46 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
2014-12-03 10:39:11 +00:00
<td class="description last"><p>The index to get the child from</p></td>
2014-11-15 20:01:46 +00:00
</tr>
</tbody>
</table>
2014-12-03 10:39:11 +00:00
<h5>Returns:</h5>
<div class="returns">
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
-
</div>
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
<div class="returns-desc param-desc">
<p>The child that was removed.</p>
2014-11-15 20:01:46 +00:00
</div>
2014-12-03 10:39:11 +00:00
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
2014-12-03 10:39:11 +00:00
<a href="PIXI.DisplayObjectContainer.html#removeChildAt">PIXI.DisplayObjectContainer#removeChildAt</a>
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-226">line 226</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2014-12-03 10:39:11 +00:00
id="removeChildren"><span class="type-signature"></span>removeChildren<span class="signature">(beginIndex, endIndex)</span><span class="type-signature"></span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
2014-12-03 10:39:11 +00:00
<p>Removes all children from this container that are within the begin and end indexes.</p>
2014-11-15 20:01:46 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2014-12-03 10:39:11 +00:00
<td class="name"><code>beginIndex</code></td>
2014-11-15 20:01:46 +00:00
<td class="type">
2014-12-03 10:39:11 +00:00
<span class="param-type">Number</span>
2014-11-15 20:01:46 +00:00
</td>
2014-12-03 10:39:11 +00:00
<td class="description last"><p>The beginning position. Default value is 0.</p></td>
2014-11-15 20:01:46 +00:00
</tr>
<tr>
2014-12-03 10:39:11 +00:00
<td class="name"><code>endIndex</code></td>
2014-11-15 20:01:46 +00:00
<td class="type">
2014-12-03 10:39:11 +00:00
<span class="param-type">Number</span>
2014-11-15 20:01:46 +00:00
</td>
2014-12-03 10:39:11 +00:00
<td class="description last"><p>The ending position. Default value is size of the container.</p></td>
2014-11-15 20:01:46 +00:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
2014-12-03 10:39:11 +00:00
<a href="PIXI.DisplayObjectContainer.html#removeChildren">PIXI.DisplayObjectContainer#removeChildren</a>
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-244">line 244</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2014-12-03 10:39:11 +00:00
id="removeStageReference"><span class="type-signature"></span>removeStageReference<span class="signature">()</span><span class="type-signature"></span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
2014-12-03 10:39:11 +00:00
<p>Removes the current stage reference from the container and all of its children.</p>
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
2014-12-03 10:39:11 +00:00
<a href="PIXI.DisplayObjectContainer.html#removeStageReference">PIXI.DisplayObjectContainer#removeStageReference</a>
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-407">line 407</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2014-12-03 10:39:11 +00:00
id="setChildIndex"><span class="type-signature"></span>setChildIndex<span class="signature">(child, index)</span><span class="type-signature"></span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
2014-12-03 10:39:11 +00:00
<p>Changes the position of an existing child in the display object container</p>
2014-11-15 20:01:46 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2014-12-03 10:39:11 +00:00
<td class="name"><code>child</code></td>
2014-11-15 20:01:46 +00:00
<td class="type">
2014-12-03 10:39:11 +00:00
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
2014-11-15 20:01:46 +00:00
</td>
2014-12-03 10:39:11 +00:00
<td class="description last"><p>The child DisplayObject instance for which you want to change the index number</p></td>
2014-11-15 20:01:46 +00:00
</tr>
2014-12-03 10:39:11 +00:00
<tr>
<td class="name"><code>index</code></td>
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
<td class="type">
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
<span class="param-type">Number</span>
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
</td>
<td class="description last"><p>The resulting index number for the child display object</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
2014-12-03 10:39:11 +00:00
<a href="PIXI.DisplayObjectContainer.html#setChildIndex">PIXI.DisplayObjectContainer#setChildIndex</a>
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-176">line 176</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2014-12-03 10:39:11 +00:00
id="setStageReference"><span class="type-signature"></span>setStageReference<span class="signature">(stage)</span><span class="type-signature"></span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
2014-12-03 10:39:11 +00:00
<p>Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.</p>
2014-11-15 20:01:46 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2014-12-03 10:39:11 +00:00
<td class="name"><code>stage</code></td>
2014-11-15 20:01:46 +00:00
<td class="type">
2015-10-15 11:06:38 +00:00
<span class="param-type">Stage</span>
2014-11-15 20:01:46 +00:00
</td>
2014-12-03 10:39:11 +00:00
<td class="description last"><p>the stage that the container will have as its current stage reference</p></td>
2014-11-15 20:01:46 +00:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
2014-12-03 10:39:11 +00:00
<a href="PIXI.DisplayObjectContainer.html#setStageReference">PIXI.DisplayObjectContainer#setStageReference</a>
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-391">line 391</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2014-12-03 10:39:11 +00:00
id="swapChildren"><span class="type-signature"></span>swapChildren<span class="signature">(child, child2)</span><span class="type-signature"></span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
2014-12-03 10:39:11 +00:00
<p>Swaps the position of 2 Display Objects within this container.</p>
2014-11-15 20:01:46 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2014-12-03 10:39:11 +00:00
<td class="name"><code>child</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
<tr>
<td class="name"><code>child2</code></td>
2014-11-15 20:01:46 +00:00
<td class="type">
2014-12-03 10:39:11 +00:00
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
2014-11-15 20:01:46 +00:00
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
2014-12-03 10:39:11 +00:00
<a href="PIXI.DisplayObjectContainer.html#swapChildren">PIXI.DisplayObjectContainer#swapChildren</a>
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-134">line 134</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-03-23 23:46:30 +00:00
id="toGlobal"><span class="type-signature"></span>toGlobal<span class="signature">(position)</span><span class="type-signature"> &rarr; {Point}</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
2014-12-03 10:39:11 +00:00
<p>Calculates the global position of the display object</p>
2014-11-15 20:01:46 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2014-12-03 10:39:11 +00:00
<td class="name"><code>position</code></td>
2014-11-15 20:01:46 +00:00
<td class="type">
2015-03-23 23:46:30 +00:00
<span class="param-type">Point</span>
2014-11-15 20:01:46 +00:00
</td>
2014-12-03 10:39:11 +00:00
<td class="description last"><p>The world origin to calculate from</p></td>
2014-11-15 20:01:46 +00:00
</tr>
</tbody>
</table>
2014-12-03 10:39:11 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
2015-03-23 23:46:30 +00:00
<span class="param-type">Point</span>
2014-12-03 10:39:11 +00:00
-
</div>
<div class="returns-desc param-desc">
<p>A point object representing the position of this object</p>
</div>
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
2014-12-03 10:39:11 +00:00
<a href="PIXI.DisplayObject.html#toGlobal">PIXI.DisplayObject#toGlobal</a>
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-576">line 576</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-03-23 23:46:30 +00:00
id="toLocal"><span class="type-signature"></span>toLocal<span class="signature">(position, <span class="optional">from</span>)</span><span class="type-signature"> &rarr; {Point}</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
2014-12-03 10:39:11 +00:00
<p>Calculates the local position of the display object relative to another point</p>
2014-11-15 20:01:46 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
2014-12-03 10:39:11 +00:00
<th>Argument</th>
2014-11-15 20:01:46 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2014-12-03 10:39:11 +00:00
<td class="name"><code>position</code></td>
<td class="type">
2015-03-23 23:46:30 +00:00
<span class="param-type">Point</span>
2014-12-03 10:39:11 +00:00
</td>
<td class="attributes">
</td>
<td class="description last"><p>The world origin to calculate from</p></td>
</tr>
<tr>
<td class="name"><code>from</code></td>
2014-11-15 20:01:46 +00:00
<td class="type">
2014-12-03 10:39:11 +00:00
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
2014-11-15 20:01:46 +00:00
</td>
2014-12-03 10:39:11 +00:00
<td class="attributes">
&lt;optional><br>
</td>
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
<td class="description last"><p>The DisplayObject to calculate the global position from</p></td>
2014-11-15 20:01:46 +00:00
</tr>
</tbody>
</table>
2014-12-03 10:39:11 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
2015-03-23 23:46:30 +00:00
<span class="param-type">Point</span>
2014-12-03 10:39:11 +00:00
-
</div>
<div class="returns-desc param-desc">
<p>A point object representing the position of this object</p>
</div>
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
2014-12-03 10:39:11 +00:00
<a href="PIXI.DisplayObject.html#toLocal">PIXI.DisplayObject#toLocal</a>
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-590">line 590</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="updateCache"><span class="type-signature"></span>updateCache<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Generates and updates the cached sprite for this object.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#updateCache">PIXI.DisplayObject#updateCache</a>
</li></dd>
<dt class="tag-source">Source -
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-566">line 566</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="updateLocalBounds"><span class="type-signature"></span>updateLocalBounds<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Update the bounds of the object</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-02-17 13:27:09 +00:00
<a href="src_pixi_primitives_Graphics.js.html">pixi/primitives/Graphics.js</a>, <a href="src_pixi_primitives_Graphics.js.html#sunlight-1-line-953">line 953</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
2016-04-22 14:15:28 +00:00
Phaser Copyright © 2012-2016 Photon Storm Ltd.
2014-11-15 20:01:46 +00:00
</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>
2016-04-22 14:15:28 +00:00
on Fri Apr 22 2016 15:11:58 GMT+0100 (GMT Daylight Time) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
2014-11-15 20:01:46 +00:00
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
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>