2014-11-15 20:01:46 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
2015-03-23 23:46:30 +00:00
< title > Phaser Source: docs/pixi-jsdoc.js< / title >
2014-11-15 20:01:46 +00:00
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/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 >
< 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 " >
2016-08-26 00:18:47 +00:00
< li class = "class-depth-0" >
< a href = "Event.html" > Event< / a >
< / li >
< li class = "class-depth-0" >
< a href = "EventTarget.html" > EventTarget< / a >
< / li >
2014-11-15 20:01:46 +00:00
< 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 >
2016-06-17 00:11:24 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.Bullet.html" > Bullet< / a >
< / li >
2014-11-15 20:01:46 +00:00
< 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 >
2016-08-26 00:18:47 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.Hermite.html" > Hermite< / a >
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.Image.html" > Image< / a >
< / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.ImageCollection.html" > ImageCollection< / a >
< / li >
2014-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 >
2016-08-26 00:18:47 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.KeyCode.html" > KeyCode< / a >
< / li >
2014-11-15 20:01:46 +00:00
< 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 >
2016-08-26 00:18:47 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.Path.html" > Path< / a >
< / li >
< li class = "class-depth-1" >
< a href = "Phaser.PathFollower.html" > PathFollower< / a >
< / li >
< li class = "class-depth-1" >
< a href = "Phaser.PathPoint.html" > PathPoint< / a >
< / li >
2014-11-15 20:01:46 +00:00
< 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 >
2016-08-26 00:18:47 +00:00
< li class = "class-depth-2" >
< a href = "Phaser.Plugin.PathManager.html" > PathManager< / a >
< / li >
2014-11-15 20:01:46 +00:00
< 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 >
2016-06-17 00:11:24 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.Weapon.html" > Weapon< / a >
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
2015-07-22 14:31:30 +00:00
< a href = "Phaser.World.html" > World< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
2015-07-22 14:31:30 +00:00
< a href = "PIXI.AbstractFilter.html" > AbstractFilter< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
2015-07-22 14:31:30 +00:00
< a href = "PIXI.BaseTexture.html" > BaseTexture< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasBuffer.html" > CanvasBuffer< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasGraphics.html" > CanvasGraphics< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasMaskManager.html" > CanvasMaskManager< / a >
< / li >
2015-08-24 14:43:45 +00:00
< li class = "class-depth-1" >
< a href = "PIXI.CanvasPool.html" > CanvasPool< / a >
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
< a href = "PIXI.CanvasRenderer.html" > CanvasRenderer< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasTinter.html" > CanvasTinter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.ComplexPrimitiveShader.html" > ComplexPrimitiveShader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.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" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.PIXI.html" > PIXI< / a >
2014-11-15 20:01:46 +00:00
< / li >
2016-07-01 15:57:13 +00:00
< li class = "class-depth-2" >
< a href = "PIXI.PIXI.DisplayObject.html" > DisplayObject< / a >
< / 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.PixiFastShader.html" > PixiFastShader< / 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.PixiShader.html" > PixiShader< / 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 >
< li class = "class-depth-1" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.WebGLBlendModeManager.html" > WebGLBlendModeManager< / 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.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 " >
2014-11-15 20:01:46 +00:00
2016-06-03 17:48:34 +00:00
< li class = "class-depth-0" >
< a href = "global.html#ANGLE_DOWN" > ANGLE_DOWN< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#ANGLE_LEFT" > ANGLE_LEFT< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#ANGLE_NORTH_EAST" > ANGLE_NORTH_EAST< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#ANGLE_NORTH_WEST" > ANGLE_NORTH_WEST< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#ANGLE_RIGHT" > ANGLE_RIGHT< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#ANGLE_SOUTH_EAST" > ANGLE_SOUTH_EAST< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#ANGLE_SOUTH_WEST" > ANGLE_SOUTH_WEST< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#ANGLE_UP" > ANGLE_UP< / a >
< / li >
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#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 >
2016-06-17 00:11:24 +00:00
< li class = "class-depth-0" >
< a href = "global.html#BOTTOM_CENTER" > BOTTOM_CENTER< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#BOTTOM_LEFT" > BOTTOM_LEFT< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#BOTTOM_RIGHT" > BOTTOM_RIGHT< / a >
< / li >
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 >
2016-06-17 00:11:24 +00:00
< li class = "class-depth-0" >
< a href = "global.html#CENTER" > CENTER< / a >
< / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-0" >
< a href = "global.html#CIRCLE" > CIRCLE< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#CREATURE" > CREATURE< / a >
< / li >
2016-06-09 16:13:31 +00:00
< li class = "class-depth-0" >
< a href = "global.html#displayList" > displayList< / a >
< / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-0" >
< a href = "global.html#DOWN" > DOWN< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#ELLIPSE" > ELLIPSE< / a >
< / li >
2016-08-26 00:18:47 +00:00
< li class = "class-depth-0" >
< a href = "global.html#emit" > emit< / a >
< / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-0" >
< a href = "global.html#EMITTER" > EMITTER< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#GAMES" > GAMES< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#GRAPHICS" > GRAPHICS< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#GROUP" > GROUP< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#HEADLESS" > HEADLESS< / a >
< / li >
2016-06-09 16:13:31 +00:00
< li class = "class-depth-0" >
< a href = "global.html#HORIZONTAL" > HORIZONTAL< / a >
< / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-0" >
< a href = "global.html#IMAGE" > IMAGE< / a >
< / li >
2016-06-09 16:13:31 +00:00
< li class = "class-depth-0" >
< a href = "global.html#LANDSCAPE" > LANDSCAPE< / a >
< / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-0" >
< a href = "global.html#LEFT" > LEFT< / a >
< / li >
2016-06-17 00:11:24 +00:00
< li class = "class-depth-0" >
< a href = "global.html#LEFT_BOTTOM" > LEFT_BOTTOM< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#LEFT_CENTER" > LEFT_CENTER< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#LEFT_TOP" > LEFT_TOP< / a >
< / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-0" >
< a href = "global.html#LINE" > LINE< / a >
< / li >
2016-08-26 00:18:47 +00:00
< li class = "class-depth-0" >
< a href = "global.html#listeners" > listeners< / a >
< / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-0" >
< a href = "global.html#MATRIX" > MATRIX< / a >
< / li >
2016-08-26 00:18:47 +00:00
< li class = "class-depth-0" >
< a href = "global.html#mixin" > mixin< / a >
< / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-0" >
< a href = "global.html#NONE" > NONE< / a >
< / li >
2016-08-26 00:18:47 +00:00
< li class = "class-depth-0" >
< a href = "global.html#off" > off< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#on" > on< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#once" > once< / a >
< / li >
2016-02-08 17:01:36 +00:00
< li class = "class-depth-0" >
< a href = "global.html#PENDING_ATLAS" > PENDING_ATLAS< / a >
< / li >
2016-08-26 00:18:47 +00:00
< li class = "class-depth-2" >
< a href = "global.html#Phaser.Path#numPointsreturn%257Bnumber%257DThetotalnumberofPathPointsinthisPath." > Phaser.Path#numPoints
return {number} The total number of PathPoints in this Path.< / a >
< / li >
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 >
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#POLYGON" > POLYGON< / a >
2014-11-15 20:01:46 +00:00
< / li >
2016-06-09 16:13:31 +00:00
< li class = "class-depth-0" >
< a href = "global.html#PORTRAIT" > PORTRAIT< / a >
< / 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#RECTANGLE" > RECTANGLE< / a >
2014-11-15 20:01:46 +00:00
< / li >
2016-08-26 00:18:47 +00:00
< li class = "class-depth-0" >
< a href = "global.html#removeAllListeners" > removeAllListeners< / a >
< / 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#RENDERTEXTURE" > RENDERTEXTURE< / 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#RETROFONT" > RETROFONT< / 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#RIGHT" > RIGHT< / a >
< / li >
2016-06-17 00:11:24 +00:00
< li class = "class-depth-0" >
< a href = "global.html#RIGHT_BOTTOM" > RIGHT_BOTTOM< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#RIGHT_CENTER" > RIGHT_CENTER< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#RIGHT_TOP" > RIGHT_TOP< / a >
< / li >
2015-07-22 14:31:30 +00:00
< 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 >
2016-08-26 00:18:47 +00:00
< li class = "class-depth-0" >
< a href = "global.html#stopImmediatePropagation" > stopImmediatePropagation< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#stopPropagation" > stopPropagation< / a >
< / li >
2015-07-22 14:31:30 +00:00
< 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 >
2016-06-17 00:11:24 +00:00
< li class = "class-depth-0" >
< a href = "global.html#TOP_CENTER" > TOP_CENTER< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#TOP_LEFT" > TOP_LEFT< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#TOP_RIGHT" > TOP_RIGHT< / a >
< / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-0" >
< a href = "global.html#UP" > UP< / 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#VERSION" > VERSION< / a >
2014-11-15 20:01:46 +00:00
< / li >
2016-06-09 16:13:31 +00:00
< li class = "class-depth-0" >
< a href = "global.html#VERTICAL" > VERTICAL< / a >
< / 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#VIDEO" > VIDEO< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#WEBGL" > WEBGL< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#WEBGL_FILTER" > WEBGL_FILTER< / a >
2014-11-15 20:01:46 +00:00
< / li >
< / ul >
< / li >
2014-11-25 00:23:44 +00:00
2014-11-15 20:01:46 +00:00
< li class = "dropdown" >
2014-11-25 00:23:44 +00:00
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Core< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
2014-12-03 10:39:11 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Game.html" > Game< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Group.html" > Group< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.World.html" > World< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Loader.html" > Loader< / a > < / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Cache.html" > Cache< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Time.html" > Time< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Camera.html" > Camera< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.StateManager.html" > State Manager< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.TweenManager.html" > Tween Manager< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.SoundManager.html" > Sound Manager< / a > < / li >
2015-01-06 06:57:25 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Input.html" > Input Manager< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.ScaleManager.html" > Scale Manager< / a > < / li >
< / ul >
< / li >
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Game Objects< b class = "caret" > < / b > < / a >
2014-11-15 20:01:46 +00:00
< ul class = "dropdown-menu " >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.GameObjectFactory.html" > Factory (game.add)< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.GameObjectCreator.html" > Creator (game.make)< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Sprite.html" > Sprite< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Image.html" > Image< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Sound.html" > Sound< / a > < / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Video.html" > Video< / a > < / li >
2015-01-06 06:57:25 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Particles.Arcade.Emitter.html" > Particle Emitter< / a > < / li >
2014-12-03 10:39:11 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Particle.html" > Particle< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Text.html" > Text< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Tween.html" > Tween< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.BitmapText.html" > BitmapText< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Tilemap.html" > Tilemap< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.BitmapData.html" > BitmapData< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.RetroFont.html" > RetroFont< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Button.html" > Button< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Animation.html" > Animation< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Graphics.html" > Graphics< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.RenderTexture.html" > RenderTexture< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.TileSprite.html" > TileSprite< / a > < / li >
< / ul >
< / li >
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Geometry< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
< li class = "class-depth-1" > < a href = "Phaser.Circle.html" > Circle< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.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-15 20:01:46 +00:00
< / ul >
< / li >
2014-11-25 00:23:44 +00:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Physics< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
< li class = "class-depth-1" > < a href = "Phaser.Physics.Arcade.html" > Arcade Physics< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.Arcade.Body.html" > Body< / a > < / li >
2016-06-17 00:11:24 +00:00
< li class = "class-depth-2" > < a href = "Phaser.Weapon.html" > Weapon< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Physics.P2.html" > P2 Physics< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.P2.Body.html" > Body< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.P2.Spring.html" > Spring< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.P2.CollisionGroup.html" > CollisionGroup< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.P2.ContactMaterial.html" > ContactMaterial< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Physics.Ninja.html" > Ninja Physics< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.Body.html" > Body< / a > < / li >
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Input< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
< li class = "class-depth-1" > < a href = "Phaser.InputHandler.html" > Input Handler< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Pointer.html" > Pointer< / a > < / li >
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 >
2016-08-26 00:18:47 +00:00
< li class = "class-depth-1" > < a href = "Phaser.KeyCode.html" > Key Codes< / a > < / li >
2014-11-25 00:23:44 +00:00
< 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 >
2016-05-19 11:36:51 +00:00
< li class = "class-depth-1" > < a href = "http://phaser.io/community/newsletter" > 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 >
2016-06-17 00:11:24 +00:00
< li class = "class-depth-1" > < a href = "http://phaser.io/community/slack" > Slack< / a > < / li >
< li class = "class-depth-1" > < a href = "http://phaser.io/community/donate" > Donate< / a > < / li >
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 = "span12" >
< div id = "main" >
2015-03-23 23:46:30 +00:00
< h1 class = "page-title" > Source: docs/pixi-jsdoc.js< / h1 >
2014-11-15 20:01:46 +00:00
< section >
< article >
< pre class = "sunlight-highlight-javascript linenums" > /**
* @namespace PIXI
*/
/**
* @fileoverview
2016-07-01 15:57:13 +00:00
* @author Richard Davey < rich@photonstorm.com>
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
2016-07-01 15:57:13 +00:00
* @class PIXI.PIXI.DisplayObject
* @description The base class for all objects that are rendered. Contains properties for position, scaling,
rotation, masks and cache handling.
This is an abstract class and should not be used on its own, rather it should be extended.
It is used internally by the likes of PIXI.Sprite.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
2016-07-01 15:57:13 +00:00
* @sourceline 7
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description The coordinates, in pixels, of this DisplayObject, relative to its parent container.
The value of this property does not reflect any positioning happening further up the display list.
To obtain that value please see the `worldPosition` property.
* @member PIXI.PIXI.DisplayObject#position
* @type {PIXIPoint}
* @default
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
2016-07-01 15:57:13 +00:00
* @sourceline 20
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description The scale of this DisplayObject. A scale of 1:1 represents the DisplayObject
at its default size. A value of 0.5 would scale this DisplayObject by half, and so on.
The value of this property does not reflect any scaling happening further up the display list.
To obtain that value please see the `worldScale` property.
* @member PIXI.PIXI.DisplayObject#scale
* @type {PIXIPoint}
* @default
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
2016-07-01 15:57:13 +00:00
* @sourceline 31
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description The pivot point of this DisplayObject that it rotates around. The values are expressed
in pixel values.
* @member PIXI.PIXI.DisplayObject#pivot
* @type {PIXIPoint}
* @default
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
2016-07-01 15:57:13 +00:00
* @sourceline 43
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description The rotation of this DisplayObject. The value is given, and expressed, in radians, and is based on
a right-handed orientation.
The value of this property does not reflect any rotation happening further up the display list.
To obtain that value please see the `worldRotation` property.
* @member PIXI.PIXI.DisplayObject#rotation
2014-11-15 20:01:46 +00:00
* @type {Number}
2016-07-01 15:57:13 +00:00
* @default
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
2016-07-01 15:57:13 +00:00
* @sourceline 51
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description The alpha value of this DisplayObject. A value of 1 is fully opaque. A value of 0 is transparent.
Please note that an object with an alpha value of 0 is skipped during the render pass.
The value of this property does not reflect any alpha values set further up the display list.
To obtain that value please see the `worldAlpha` property.
* @member PIXI.PIXI.DisplayObject#alpha
2014-11-15 20:01:46 +00:00
* @type {Number}
2016-07-01 15:57:13 +00:00
* @default
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
2016-07-01 15:57:13 +00:00
* @sourceline 63
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description The visibility of this DisplayObject. A value of `false` makes the object invisible.
A value of `true` makes it visible. Please note that an object with a visible value of
`false` is skipped during the render pass. Equally a DisplayObject with visible false will
not render any of its children.
The value of this property does not reflect any visible values set further up the display list.
To obtain that value please see the `worldVisible` property.
* @member PIXI.PIXI.DisplayObject#visible
2014-11-15 20:01:46 +00:00
* @type {Boolean}
2016-07-01 15:57:13 +00:00
* @default
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
2016-07-01 15:57:13 +00:00
* @sourceline 75
2014-11-15 20:01:46 +00:00
*/
/**
* @description 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)
2016-07-01 15:57:13 +00:00
* @member PIXI.PIXI.DisplayObject#hitArea
2015-03-23 23:46:30 +00:00
* @type {(Rectangle|Circle|Ellipse|Polygon)}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
2016-07-01 15:57:13 +00:00
* @sourceline 89
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description Should this DisplayObject be rendered by the renderer? An object with a renderable value of
`false` is skipped during the render pass.
* @member PIXI.PIXI.DisplayObject#renderable
2014-11-15 20:01:46 +00:00
* @type {Boolean}
2016-07-01 15:57:13 +00:00
* @default
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
2016-07-01 15:57:13 +00:00
* @sourceline 98
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description The parent DisplayObjectContainer that this DisplayObject is a child of.
All DisplayObjects must belong to a parent in order to be rendered.
The root parent is the Stage object. This property is set automatically when the
DisplayObject is added to, or removed from, a DisplayObjectContainer.
* @member PIXI.PIXI.DisplayObject#parent
* @type {PIXIDisplayObjectContainer}
2014-11-15 20:01:46 +00:00
* @readonly
2016-07-01 15:57:13 +00:00
* @default
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
2016-07-01 15:57:13 +00:00
* @sourceline 107
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description The multiplied alpha value of this DisplayObject. A value of 1 is fully opaque. A value of 0 is transparent.
This value is the calculated total, based on the alpha values of all parents of this DisplayObjects
in the display list.
To obtain, and set, the local alpha value, see the `alpha` property.
Note: This property is only updated at the end of the `updateTransform` call, once per render. Until
that happens this property will contain values based on the previous frame. Be mindful of this if
accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.
* @member PIXI.PIXI.DisplayObject#worldAlpha
2014-11-15 20:01:46 +00:00
* @type {Number}
* @readonly
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 119
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description The current transform of this DisplayObject.
This property contains the calculated total, based on the transforms of all parents of this
DisplayObject in the display list.
Note: This property is only updated at the end of the `updateTransform` call, once per render. Until
that happens this property will contain values based on the previous frame. Be mindful of this if
accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.
* @member PIXI.PIXI.DisplayObject#worldTransform
* @type {PIXIMatrix}
2014-11-15 20:01:46 +00:00
* @readonly
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 135
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description The coordinates, in pixels, of this DisplayObject within the world.
This property contains the calculated total, based on the positions of all parents of this
DisplayObject in the display list.
Note: This property is only updated at the end of the `updateTransform` call, once per render. Until
that happens this property will contain values based on the previous frame. Be mindful of this if
accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.
* @member PIXI.PIXI.DisplayObject#worldPosition
* @type {PIXIPoint}
2015-07-22 14:31:30 +00:00
* @readonly
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 150
2015-07-22 14:31:30 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description The global scale of this DisplayObject.
This property contains the calculated total, based on the scales of all parents of this
DisplayObject in the display list.
Note: This property is only updated at the end of the `updateTransform` call, once per render. Until
that happens this property will contain values based on the previous frame. Be mindful of this if
accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.
* @member PIXI.PIXI.DisplayObject#worldScale
* @type {PIXIPoint}
2015-07-22 14:31:30 +00:00
* @readonly
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 165
2015-07-22 14:31:30 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description The rotation, in radians, of this DisplayObject.
This property contains the calculated total, based on the rotations of all parents of this
DisplayObject in the display list.
Note: This property is only updated at the end of the `updateTransform` call, once per render. Until
that happens this property will contain values based on the previous frame. Be mindful of this if
accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.
* @member PIXI.PIXI.DisplayObject#worldRotation
2015-07-22 14:31:30 +00:00
* @type {Number}
* @readonly
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 180
2015-07-22 14:31:30 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description The rectangular area used by filters when rendering a shader for this DisplayObject.
* @member PIXI.PIXI.DisplayObject#filterArea
* @type {Rectangle}
* @default
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 195
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @member PIXI.PIXI.DisplayObject#_sr - Cached rotation value.
2014-11-15 20:01:46 +00:00
* @type {Number}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 204
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @member PIXI.PIXI.DisplayObject#_cr - Cached rotation value.
* @type {Number}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 210
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @member PIXI.PIXI.DisplayObject#_bounds - The cached bounds of this object.
* @type {PIXIRectangle}
2014-11-15 20:01:46 +00:00
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 216
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @member PIXI.PIXI.DisplayObject#_currentBounds - The most recently calculated bounds of this object.
* @type {PIXIRectangle}
2014-11-15 20:01:46 +00:00
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 222
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @member PIXI.PIXI.DisplayObject#_mask - The cached mask of this object.
* @type {PIXIRectangle}
2014-11-15 20:01:46 +00:00
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 228
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @member PIXI.PIXI.DisplayObject#_cacheAsBitmap - Internal cache as bitmap flag.
2014-11-15 20:01:46 +00:00
* @type {Boolean}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 234
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @member PIXI.PIXI.DisplayObject#_cacheIsDirty - Internal dirty cache flag.
2014-11-15 20:01:46 +00:00
* @type {Boolean}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 240
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Destroy this DisplayObject.
2015-08-24 14:43:45 +00:00
2016-08-26 00:18:47 +00:00
Removes any cached sprites, sets renderable flag to false, and nulls filters, bounds and mask.
2015-08-24 14:43:45 +00:00
2016-07-01 15:57:13 +00:00
Also iteratively calls `destroy` on any children.
* @method PIXI.PIXI.DisplayObject#PIXI.DisplayObject#destroy
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 252
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description To be overridden by classes that require it.
* @method PIXI.PIXI.DisplayObject#PIXI.DisplayObject#preUpdate
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 403
2015-03-23 23:46:30 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description Generates a RenderTexture based on this DisplayObject, which can they be used to texture other Sprites.
This can be useful if your DisplayObject is static, or complicated, and needs to be reused multiple times.
Please note that no garbage collection takes place on old textures. It is up to you to destroy old textures,
and references to them, so they don't linger in memory.
* @method PIXI.PIXI.DisplayObject#PIXI.DisplayObject#generateTexture
* @param {Number} [resolution=1] - - The resolution of the texture being generated.
* @param {Number} [scaleMode=PIXI.scaleModes.DEFAULT] - - See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values.
* @param {(PIXICanvasRenderer|PIXIWebGLRenderer)} renderer - - The renderer used to generate the texture.
* @return {PIXIRenderTexture} - A RenderTexture containing an image of this DisplayObject at the time it was invoked.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 412
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description If this DisplayObject has a cached Sprite, this method generates and updates it.
* @method PIXI.PIXI.DisplayObject#PIXI.DisplayObject#updateCache
* @return {PIXIDisplayObject} - A reference to this DisplayObject.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 440
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description Calculates the global position of this DisplayObject, based on the position given.
* @method PIXI.PIXI.DisplayObject#PIXI.DisplayObject#toGlobal
* @param {PIXIPoint} position - - The global position to calculate from.
* @return {PIXIPoint} - A point object representing the position of this DisplayObject based on the global position given.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 454
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description Calculates the local position of this DisplayObject, relative to another point.
* @method PIXI.PIXI.DisplayObject#PIXI.DisplayObject#toLocal
* @param {PIXIPoint} position - - The world origin to calculate from.
* @param {PIXIDisplayObject} [from] - - An optional DisplayObject to calculate the global position from.
* @return {PIXIPoint} - A point object representing the position of this DisplayObject based on the global position given.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 469
2014-11-15 20:01:46 +00:00
*/
/**
* @description Internal method.
2016-07-01 15:57:13 +00:00
* @method PIXI.PIXI.DisplayObject#PIXI.DisplayObject#_renderCachedSprite
* @param {Object} renderSession - - The render session
2014-11-15 20:01:46 +00:00
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 490
2014-11-15 20:01:46 +00:00
*/
/**
* @description Internal method.
2016-07-01 15:57:13 +00:00
* @method PIXI.PIXI.DisplayObject#PIXI.DisplayObject#_generateCachedSprite
2014-11-15 20:01:46 +00:00
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 512
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description Destroys a cached Sprite.
* @method PIXI.PIXI.DisplayObject#PIXI.DisplayObject#_destroyCachedSprite
2014-11-15 20:01:46 +00:00
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 560
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description The horizontal position of the DisplayObject, in pixels, relative to its parent.
If you need the world position of the DisplayObject, use `DisplayObject.worldPosition` instead.
* @member PIXI.PIXI.DisplayObject#x - The horizontal position of the DisplayObject, in pixels, relative to its parent.
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 586
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description The vertical position of the DisplayObject, in pixels, relative to its parent.
If you need the world position of the DisplayObject, use `DisplayObject.worldPosition` instead.
* @member PIXI.PIXI.DisplayObject#y - The vertical position of the DisplayObject, in pixels, relative to its parent.
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 608
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description Indicates if this DisplayObject is visible, based on it, and all of its parents, `visible` property values.
* @member PIXI.PIXI.DisplayObject#worldVisible - Indicates if this DisplayObject is visible, based on it, and all of its parents, `visible` property values.
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 630
2014-11-15 20:01:46 +00:00
*/
/**
2016-07-01 15:57:13 +00:00
* @description Sets a mask for this DisplayObject. A mask is an instance of a Graphics object.
When applied it limits the visible area of this DisplayObject to the shape of the mask.
Under a Canvas renderer it uses shape clipping. Under a WebGL renderer it uses a Stencil Buffer.
To remove a mask, set this property to `null`.
* @member PIXI.PIXI.DisplayObject#mask - The mask applied to this DisplayObject. Set to `null` to remove an existing mask.
* @type {PIXIGraphics}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 673
2016-07-01 15:57:13 +00:00
*/
/**
* @description Sets the filters for this DisplayObject. This is a WebGL only feature, and is ignored by the Canvas
Renderer. A filter is a shader applied to this DisplayObject. You can modify the placement of the filter
using `DisplayObject.filterArea`.
To remove filters, set this property to `null`.
Note: You cannot have a filter set, and a MULTIPLY Blend Mode active, at the same time. Setting a
filter will reset this DisplayObjects blend mode to NORMAL.
* @member PIXI.PIXI.DisplayObject#filters - An Array of PIXI.AbstractFilter objects, or objects that extend them.
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 708
2016-07-01 15:57:13 +00:00
*/
/**
* @description Sets if this DisplayObject should be cached as a bitmap.
When invoked it will take a snapshot of the DisplayObject, as it is at that moment, and store it
in a RenderTexture. This is then used whenever this DisplayObject is rendered. It can provide a
performance benefit for complex, but static, DisplayObjects. I.e. those with lots of children.
Cached Bitmaps do not track their parents. If you update a property of this DisplayObject, it will not
re-generate the cached bitmap automatically. To do that you need to call `DisplayObject.updateCache`.
To remove a cached bitmap, set this property to `null`.
* @member PIXI.PIXI.DisplayObject#cacheAsBitmap - Cache this DisplayObject as a Bitmap. Set to `null` to remove an existing cached bitmap.
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObject.js
* @sourceline 761
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.DisplayObjectContainer
* @description A DisplayObjectContainer represents a collection of display objects.
It is the base class of all display objects that act as a container for other objects.
2016-07-01 15:57:13 +00:00
* @augments DisplayObject
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @description [read-only] The array of children of this container.
* @member PIXI.DisplayObjectContainer#children
* @type {Array< DisplayObject>}
* @readonly
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
2014-11-15 20:01:46 +00:00
* @sourceline 17
*/
/**
2016-06-09 16:13:31 +00:00
* @description If `ignoreChildInput` is `false` it will allow this objects _children_ to be considered as valid for Input events.
If this property is `true` then the children will _not_ be considered as valid for Input events.
Note that this property isn't recursive: only immediate children are influenced, it doesn't scan further down.
* @member PIXI.DisplayObjectContainer#ignoreChildInput
* @type {Boolean}
* @default
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
2016-06-09 16:13:31 +00:00
* @sourceline 26
*/
/**
2014-11-15 20:01:46 +00:00
* @description Adds a child to the container.
* @method PIXI.DisplayObjectContainer#addChild
2016-07-01 15:57:13 +00:00
* @param {DisplayObject} child - The DisplayObject to add to the container
* @return {DisplayObject} The child that was added.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
* @sourceline 42
2014-11-15 20:01:46 +00:00
*/
/**
* @description Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
* @method PIXI.DisplayObjectContainer#addChildAt
2016-07-01 15:57:13 +00:00
* @param {DisplayObject} child - The child to add
2014-11-15 20:01:46 +00:00
* @param {Number} index - The index to place the child in
2016-07-01 15:57:13 +00:00
* @return {DisplayObject} The child that was added.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
* @sourceline 55
2014-11-15 20:01:46 +00:00
*/
/**
* @description Swaps the position of 2 Display Objects within this container.
* @method PIXI.DisplayObjectContainer#swapChildren
2016-07-01 15:57:13 +00:00
* @param {DisplayObject} child -
* @param {DisplayObject} child2 -
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
* @sourceline 85
2014-11-15 20:01:46 +00:00
*/
/**
* @description Returns the index position of a child DisplayObject instance
* @method PIXI.DisplayObjectContainer#getChildIndex
2016-07-01 15:57:13 +00:00
* @param {DisplayObject} child - The DisplayObject instance to identify
2014-11-15 20:01:46 +00:00
* @return {Number} The index position of the child display object to identify
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
* @sourceline 112
2014-11-15 20:01:46 +00:00
*/
/**
* @description Changes the position of an existing child in the display object container
* @method PIXI.DisplayObjectContainer#setChildIndex
2016-07-01 15:57:13 +00:00
* @param {DisplayObject} child - The child DisplayObject instance for which you want to change the index number
2014-11-15 20:01:46 +00:00
* @param {Number} index - The resulting index number for the child display object
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
* @sourceline 132
2014-11-15 20:01:46 +00:00
*/
/**
* @description Returns the child at the specified index
* @method PIXI.DisplayObjectContainer#getChildAt
* @param {Number} index - The index to get the child from
2016-07-01 15:57:13 +00:00
* @return {DisplayObject} The child at the given index, if any.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
* @sourceline 153
2014-11-15 20:01:46 +00:00
*/
/**
* @description Removes a child from the container.
* @method PIXI.DisplayObjectContainer#removeChild
2016-07-01 15:57:13 +00:00
* @param {DisplayObject} child - The DisplayObject to remove
* @return {DisplayObject} The child that was removed.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
* @sourceline 171
2014-11-15 20:01:46 +00:00
*/
/**
* @description Removes a child from the specified index position.
* @method PIXI.DisplayObjectContainer#removeChildAt
* @param {Number} index - The index to get the child from
2016-07-01 15:57:13 +00:00
* @return {DisplayObject} The child that was removed.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
* @sourceline 191
2014-11-15 20:01:46 +00:00
*/
/**
* @description Removes all children from this container that are within the begin and end indexes.
* @method PIXI.DisplayObjectContainer#removeChildren
* @param {Number} beginIndex - The beginning position. Default value is 0.
* @param {Number} endIndex - The ending position. Default value is size of the container.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
* @sourceline 213
2014-11-15 20:01:46 +00:00
*/
/**
2016-08-26 00:18:47 +00:00
* @description Retrieves the global bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.
2014-11-15 20:01:46 +00:00
* @method PIXI.DisplayObjectContainer#getBounds
2016-08-26 00:18:47 +00:00
* @param {(PIXIDisplayObject|PIXIMatrix)} [targetCoordinateSpace] - Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.
2015-03-23 23:46:30 +00:00
* @return {Rectangle} The rectangular bounding area
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
* @sourceline 280
2014-11-15 20:01:46 +00:00
*/
/**
2016-08-26 00:18:47 +00:00
* @description Retrieves the non-global local bounds of the displayObjectContainer as a rectangle without any transformations. The calculation takes all visible children into consideration.
2014-11-15 20:01:46 +00:00
* @method PIXI.DisplayObjectContainer#getLocalBounds
2015-03-23 23:46:30 +00:00
* @return {Rectangle} The rectangular bounding area
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
* @sourceline 437
2014-11-15 20:01:46 +00:00
*/
/**
2016-08-26 00:18:47 +00:00
* @description Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
* @method PIXI.DisplayObjectContainer#contains
* @param {DisplayObject} child -
* @return {Boolean}
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
* @sourceline 449
2014-11-15 20:01:46 +00:00
*/
/**
* @description Renders the object using the WebGL renderer
* @method PIXI.DisplayObjectContainer#_renderWebGL
* @param {RenderSession} renderSession -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
* @sourceline 472
2014-11-15 20:01:46 +00:00
*/
/**
* @description Renders the object using the Canvas renderer
* @method PIXI.DisplayObjectContainer#_renderCanvas
* @param {RenderSession} renderSession -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
* @sourceline 534
*/
/**
* @description The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
* @member PIXI.DisplayObjectContainer#width
* @type {Number}
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
* @sourceline 571
*/
/**
* @description The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
* @member PIXI.DisplayObjectContainer#height
* @type {Number}
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/DisplayObjectContainer.js
* @sourceline 600
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.Sprite
* @description The Sprite object is the base for all textured objects that are rendered to the screen
* @augments PIXI.DisplayObjectContainer
* @param {PIXI.Texture} texture - The texture for this sprite
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @description The anchor sets the origin point of the texture.
The default is 0,0 this means the texture's origin is the top left
Setting than anchor to 0.5,0.5 means the textures origin is centered
Setting the anchor to 1,1 would mean the textures origin points will be the bottom right corner
* @member PIXI.Sprite#anchor
2015-03-23 23:46:30 +00:00
* @type {Point}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 17
2014-11-15 20:01:46 +00:00
*/
/**
* @description The texture that the sprite is using
* @member PIXI.Sprite#texture
* @type {PIXI.Texture}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 28
2014-11-15 20:01:46 +00:00
*/
/**
* @description The width of the sprite (this is initially set by the texture)
* @member PIXI.Sprite#_width
* @type {Number}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 36
2014-11-15 20:01:46 +00:00
*/
/**
* @description The height of the sprite (this is initially set by the texture)
* @member PIXI.Sprite#_height
* @type {Number}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 45
2014-11-15 20:01:46 +00:00
*/
/**
* @description The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.
* @member PIXI.Sprite#tint
* @type {Number}
* @default 0xFFFFFF
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 54
2014-11-15 20:01:46 +00:00
*/
/**
2015-07-22 14:31:30 +00:00
* @description The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.
* @member PIXI.Sprite#cachedTint
* @type {Number}
* @default -1
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 63
2015-07-22 14:31:30 +00:00
*/
/**
* @description A canvas that contains the tinted version of the Sprite (in Canvas mode, WebGL doesn't populate this)
* @member PIXI.Sprite#tintedTexture
* @type {Canvas}
* @default null
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 73
2015-07-22 14:31:30 +00:00
*/
/**
2014-11-15 20:01:46 +00:00
* @description The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.
2015-08-24 14:43:45 +00:00
Warning: You cannot have a blend mode and a filter active on the same Sprite. Doing so will render the sprite invisible.
2014-11-15 20:01:46 +00:00
* @member PIXI.Sprite#blendMode
* @type {Number}
* @default PIXI.blendModes.NORMAL;
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 82
2014-11-15 20:01:46 +00:00
*/
/**
2016-08-26 00:18:47 +00:00
* @description The shader that will be used to render this Sprite.
Set to null to remove a current shader.
2014-11-15 20:01:46 +00:00
* @member PIXI.Sprite#shader
* @type {PIXI.AbstractFilter}
* @default null
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 93
2014-11-15 20:01:46 +00:00
*/
/**
2016-06-17 00:11:24 +00:00
* @description Controls if this Sprite is processed by the core Phaser game loops and Group loops.
* @member PIXI.Sprite#exists
* @type {Boolean}
* @default true
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 103
2016-06-17 00:11:24 +00:00
*/
/**
2014-11-15 20:01:46 +00:00
* @description The width of the sprite, setting this will actually modify the scale to achieve the value set
* @member PIXI.Sprite#width
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 125
2014-11-15 20:01:46 +00:00
*/
/**
* @description The height of the sprite, setting this will actually modify the scale to achieve the value set
* @member PIXI.Sprite#height
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 144
2014-11-15 20:01:46 +00:00
*/
/**
2015-08-24 14:43:45 +00:00
* @description Sets the texture of the sprite. Be warned that this doesn't remove or destroy the previous
texture this Sprite was using.
2014-11-15 20:01:46 +00:00
* @method PIXI.Sprite#setTexture
* @param {PIXI.Texture} texture - The PIXI texture that is displayed by the sprite
2015-08-24 14:43:45 +00:00
* @param {Boolean} [destroy=false] - Call Texture.destroy on the current texture before replacing it with the new one?
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 163
2014-11-15 20:01:46 +00:00
*/
/**
* @description When the texture is updated, this event will fire to update the scale and frame
* @method PIXI.Sprite#onTextureUpdate
* @param {} event -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 185
2014-11-15 20:01:46 +00:00
*/
/**
2016-05-19 11:36:51 +00:00
* @description Returns the bounds of the Sprite as a rectangle.
The bounds calculation takes the worldTransform into account.
It is important to note that the transform is not updated when you call this method.
So if this Sprite is the child of a Display Object which has had its transform
updated since the last render pass, those changes will not yet have been applied
to this Sprites worldTransform. If you need to ensure that all parent transforms
are factored into this getBounds operation then you should call `updateTransform`
on the root most object in this Sprites display list first.
2014-11-15 20:01:46 +00:00
* @method PIXI.Sprite#getBounds
2015-03-23 23:46:30 +00:00
* @param {Matrix} matrix - the transformation matrix of the sprite
* @return {Rectangle} the framing rectangle
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 199
*/
/**
* @description Retrieves the non-global local bounds of the Sprite as a rectangle. The calculation takes all visible children into consideration.
* @method PIXI.Sprite#getLocalBounds
* @return {Rectangle} The rectangular bounding area
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 315
2014-11-15 20:01:46 +00:00
*/
/**
* @description Renders the object using the WebGL renderer
* @method PIXI.Sprite#_renderWebGL
* @param {RenderSession} renderSession -
2015-07-22 14:31:30 +00:00
* @param {Matrix} [matrix] - - Optional matrix. If provided the Display Object will be rendered using this matrix, otherwise it will use its worldTransform.
2014-11-15 20:01:46 +00:00
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 345
2014-11-15 20:01:46 +00:00
*/
/**
* @description Renders the object using the Canvas renderer
* @method PIXI.Sprite#_renderCanvas
* @param {RenderSession} renderSession -
2015-07-22 14:31:30 +00:00
* @param {Matrix} [matrix] - - Optional matrix. If provided the Display Object will be rendered using this matrix, otherwise it will use its worldTransform.
2014-11-15 20:01:46 +00:00
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/Sprite.js
* @sourceline 415
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/SpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.SpriteBatch
* @description The SpriteBatch class is a really fast version of the DisplayObjectContainer
built solely for speed, so use when you need a lot of sprites or particles.
And it's extremely easy to use :
var container = new PIXI.SpriteBatch();
for(var i = 0; i < 100; i++)
{
var sprite = new PIXI.Sprite.fromImage("myImage.png");
container.addChild(sprite);
}
And here you have a hundred sprites that will be renderer at the speed of light
* @param {PIXI.Texture} texture -
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/SpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @description Renders the object using the WebGL renderer
* @method PIXI.SpriteBatch#_renderWebGL
* @param {RenderSession} renderSession -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/SpriteBatch.js
* @sourceline 62
2014-11-15 20:01:46 +00:00
*/
/**
* @description Renders the object using the Canvas renderer
* @method PIXI.SpriteBatch#_renderCanvas
* @param {RenderSession} renderSession -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/display/SpriteBatch.js
* @sourceline 94
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/Rope.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.Rope
* @augments PIXI.Strip
* @param {PIXI.Texture} texture - - The texture to use on the rope.
* @param {Array} points - - An array of {PIXI.Point}.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/Rope.js
2014-11-15 20:01:46 +00:00
* @sourceline 6
*/
/**
2015-03-23 23:46:30 +00:00
* @fileoverview
* @author Mat Groves http://matgroves.com/
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/Strip.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
2014-11-25 00:23:44 +00:00
* @class PIXI.Strip
2014-11-15 20:01:46 +00:00
* @augments PIXI.DisplayObjectContainer
2014-11-25 00:23:44 +00:00
* @param {PIXI.Texture} texture - The texture to use
* @param {Number} width - the width
* @param {Number} height - the height
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/Strip.js
2014-11-25 00:23:44 +00:00
* @sourceline 5
2014-11-15 20:01:46 +00:00
*/
/**
* @description The texture of the strip
* @member PIXI.Strip#texture
* @type {PIXI.Texture}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/Strip.js
2014-11-15 20:01:46 +00:00
* @sourceline 20
*/
/**
* @description Whether the strip is dirty or not
* @member PIXI.Strip#dirty
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/Strip.js
2014-11-15 20:01:46 +00:00
* @sourceline 43
*/
/**
* @description The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.
* @member PIXI.Strip#blendMode
* @type {Number}
* @default PIXI.blendModes.NORMAL;
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/Strip.js
2014-11-15 20:01:46 +00:00
* @sourceline 51
*/
/**
2014-12-03 10:39:11 +00:00
* @description Triangles in canvas mode are automatically antialiased, use this value to force triangles to overlap a bit with each other.
* @member PIXI.Strip#canvasPadding
2014-11-15 20:01:46 +00:00
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/Strip.js
2014-11-15 20:01:46 +00:00
* @sourceline 60
*/
/**
* @description Renders a flat strip
* @method PIXI.Strip#renderStripFlat
* @param {PIXI.Strip} strip - The Strip to render
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/Strip.js
2016-05-19 11:36:51 +00:00
* @sourceline 344
2014-11-15 20:01:46 +00:00
*/
/**
* @description When the texture is updated, this event will fire to update the scale and frame
* @method PIXI.Strip#onTextureUpdate
* @param {} event -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/Strip.js
2016-05-19 11:36:51 +00:00
* @sourceline 392
2014-11-25 00:23:44 +00:00
*/
/**
* @description Returns the bounds of the mesh as a rectangle. The bounds calculation takes the worldTransform into account.
* @method PIXI.Strip#getBounds
2015-03-23 23:46:30 +00:00
* @param {Matrix} matrix - the transformation matrix of the sprite
* @return {Rectangle} the framing rectangle
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/Strip.js
2016-05-19 11:36:51 +00:00
* @sourceline 405
2014-11-25 00:23:44 +00:00
*/
/**
* @description Different drawing buffer modes supported
* @member PIXI.Strip.
2014-12-03 10:39:11 +00:00
* @type {{TRIANGLE_STRIP: number, TRIANGLES: number}}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/Strip.js
2016-05-19 11:36:51 +00:00
* @sourceline 462
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.TilingSprite
* @description A tiling sprite is a fast way of rendering a tiling image
* @augments PIXI.Sprite
* @param {PIXI.Texture} texture - the texture of the tiling sprite
* @param {Number} width - the width of the tiling sprite
* @param {Number} height - the height of the tiling sprite
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
2015-07-22 14:31:30 +00:00
* @description The width of the tiling sprite
2014-11-15 20:01:46 +00:00
* @member PIXI.TilingSprite#width
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2014-11-15 20:01:46 +00:00
* @sourceline 19
*/
/**
* @description The height of the tiling sprite
* @member PIXI.TilingSprite#height
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2014-11-15 20:01:46 +00:00
* @sourceline 27
*/
/**
* @description The scaling of the image that is being tiled
* @member PIXI.TilingSprite#tileScale
2015-03-23 23:46:30 +00:00
* @type {Point}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2014-11-15 20:01:46 +00:00
* @sourceline 35
*/
/**
* @description A point that represents the scale of the texture object
* @member PIXI.TilingSprite#tileScaleOffset
2015-03-23 23:46:30 +00:00
* @type {Point}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2014-11-15 20:01:46 +00:00
* @sourceline 43
*/
/**
* @description The offset position of the image that is being tiled
* @member PIXI.TilingSprite#tilePosition
2015-03-23 23:46:30 +00:00
* @type {Point}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2014-11-15 20:01:46 +00:00
* @sourceline 51
*/
/**
* @description Whether this sprite is renderable or not
* @member PIXI.TilingSprite#renderable
* @type {Boolean}
* @default true
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2014-11-15 20:01:46 +00:00
* @sourceline 59
*/
/**
* @description The tint applied to the sprite. This is a hex value
* @member PIXI.TilingSprite#tint
* @type {Number}
* @default 0xFFFFFF
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2014-11-15 20:01:46 +00:00
* @sourceline 68
*/
/**
2015-07-22 14:31:30 +00:00
* @description If enabled a green rectangle will be drawn behind the generated tiling texture, allowing you to visually
debug the texture being used.
* @member PIXI.TilingSprite#textureDebug
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2015-07-22 14:31:30 +00:00
* @sourceline 77
*/
/**
2014-11-15 20:01:46 +00:00
* @description The blend mode to be applied to the sprite
* @member PIXI.TilingSprite#blendMode
* @type {Number}
* @default PIXI.blendModes.NORMAL;
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2015-07-22 14:31:30 +00:00
* @sourceline 86
2014-11-15 20:01:46 +00:00
*/
/**
2015-07-22 14:31:30 +00:00
* @description The CanvasBuffer object that the tiled texture is drawn to.
* @member PIXI.TilingSprite#canvasBuffer
* @type {PIXICanvasBuffer}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2014-11-15 20:01:46 +00:00
* @sourceline 95
*/
/**
2015-07-22 14:31:30 +00:00
* @description An internal Texture object that holds the tiling texture that was generated from TilingSprite.texture.
* @member PIXI.TilingSprite#tilingTexture
* @type {PIXITexture}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2015-07-22 14:31:30 +00:00
* @sourceline 103
*/
/**
* @description The Context fill pattern that is used to draw the TilingSprite in Canvas mode only (will be null in WebGL).
* @member PIXI.TilingSprite#tilePattern
* @type {PIXITexture}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2014-11-15 20:01:46 +00:00
* @sourceline 111
*/
/**
2015-07-22 14:31:30 +00:00
* @description If true the TilingSprite will run generateTexture on its **next** render pass.
This is set by the likes of Phaser.LoadTexture.setFrame.
* @member PIXI.TilingSprite#refreshTexture
* @type {Boolean}
* @default true
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2015-07-22 14:31:30 +00:00
* @sourceline 119
*/
/**
2014-11-15 20:01:46 +00:00
* @description Renders the object using the WebGL renderer
* @method PIXI.TilingSprite#_renderWebGL
* @param {RenderSession} renderSession -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2015-07-22 14:31:30 +00:00
* @sourceline 148
2014-11-15 20:01:46 +00:00
*/
/**
* @description Renders the object using the Canvas renderer
* @method PIXI.TilingSprite#_renderCanvas
* @param {RenderSession} renderSession -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2015-07-22 14:31:30 +00:00
* @sourceline 216
2014-11-15 20:01:46 +00:00
*/
/**
* @description When the texture is updated, this event will fire to update the scale and frame
* @method PIXI.TilingSprite#onTextureUpdate
* @param {} event -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2016-05-19 11:36:51 +00:00
* @sourceline 320
2014-11-15 20:01:46 +00:00
*/
/**
* @method PIXI.TilingSprite#generateTilingTexture
* @param {Boolean} forcePowerOfTwo - Whether we want to force the texture to be a power of two
2015-10-15 11:06:38 +00:00
* @param {RenderSession} renderSession -
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2016-05-19 11:36:51 +00:00
* @sourceline 332
2015-07-22 14:31:30 +00:00
*/
/**
* @description Returns the framing rectangle of the sprite as a PIXI.Rectangle object
* @method PIXI.TilingSprite#getBounds
* @return {Rectangle} the framing rectangle
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2016-02-08 17:01:36 +00:00
* @sourceline 417
2015-07-22 14:31:30 +00:00
*/
/**
* @description The width of the sprite, setting this will actually modify the scale to achieve the value set
* @member PIXI.TilingSprite#width
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2016-02-08 17:01:36 +00:00
* @sourceline 517
2015-07-22 14:31:30 +00:00
*/
/**
* @description The height of the TilingSprite, setting this will actually modify the scale to achieve the value set
* @member PIXI.TilingSprite#height
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/extras/TilingSprite.js
2016-02-08 17:01:36 +00:00
* @sourceline 535
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/filters/AbstractFilter.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.AbstractFilter
* @description This is the base class for creating a PIXI filter. Currently only webGL supports filters.
If you want to make a custom filter this should be your base class.
* @param {Array} fragmentSrc - The fragment source in an array of strings.
* @param {Object} uniforms - An object containing the uniforms for this filter.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/filters/AbstractFilter.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @description An array of passes - some filters contain a few steps this array simply stores the steps in a liniear fashion.
For example the blur filter has two passes blurX and blurY.
* @member PIXI.AbstractFilter#passes
2016-06-17 11:46:47 +00:00
* @type {Array}
2014-11-15 20:01:46 +00:00
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/filters/AbstractFilter.js
2016-06-17 11:46:47 +00:00
* @sourceline 16
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.AbstractFilter#shaders
2016-06-17 11:46:47 +00:00
* @type {Array}
2014-11-15 20:01:46 +00:00
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/filters/AbstractFilter.js
2016-06-17 11:46:47 +00:00
* @sourceline 25
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.AbstractFilter#dirty
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/filters/AbstractFilter.js
2016-06-17 11:46:47 +00:00
* @sourceline 32
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.AbstractFilter#padding
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/filters/AbstractFilter.js
2016-06-17 11:46:47 +00:00
* @sourceline 38
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.AbstractFilter#uniforms
2016-06-17 11:46:47 +00:00
* @type {Object}
2014-11-15 20:01:46 +00:00
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/filters/AbstractFilter.js
2016-06-17 11:46:47 +00:00
* @sourceline 44
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.AbstractFilter#fragmentSrc
* @type {Array}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/filters/AbstractFilter.js
2016-06-17 11:46:47 +00:00
* @sourceline 51
2014-11-15 20:01:46 +00:00
*/
/**
* @description Syncs the uniforms between the class object and the shaders.
* @method PIXI.AbstractFilter#syncUniforms
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/filters/AbstractFilter.js
2016-06-17 11:46:47 +00:00
* @sourceline 61
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
2015-03-23 23:46:30 +00:00
* @class PIXI.Graphics
* @description The Graphics class contains methods used to draw primitive shapes such as lines, circles and rectangles to the display, and color and fill them.
* @augments PIXI.DisplayObjectContainer
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
2015-03-23 23:46:30 +00:00
* @description The alpha value used when filling the Graphics object.
* @member PIXI.Graphics#fillAlpha
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
2015-03-23 23:46:30 +00:00
* @sourceline 18
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description The width (thickness) of any lines drawn.
* @member PIXI.Graphics#lineWidth
2014-11-15 20:01:46 +00:00
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
2015-03-23 23:46:30 +00:00
* @sourceline 26
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description The color of any lines drawn.
* @member PIXI.Graphics#lineColor
* @type {String}
* @default 0
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
2015-03-23 23:46:30 +00:00
* @sourceline 34
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Graphics data
* @member PIXI.Graphics#graphicsData
* @type {Array}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
2015-03-23 23:46:30 +00:00
* @sourceline 43
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description The tint applied to the graphic shape. This is a hex value. Apply a value of 0xFFFFFF to reset the tint.
* @member PIXI.Graphics#tint
2014-11-15 20:01:46 +00:00
* @type {Number}
2015-03-23 23:46:30 +00:00
* @default 0xFFFFFF
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
2015-03-23 23:46:30 +00:00
* @sourceline 52
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description The blend mode to be applied to the graphic shape. Apply a value of PIXI.blendModes.NORMAL to reset the blend mode.
* @member PIXI.Graphics#blendMode
2014-11-15 20:01:46 +00:00
* @type {Number}
2015-03-23 23:46:30 +00:00
* @default PIXI.blendModes.NORMAL;
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
2015-03-23 23:46:30 +00:00
* @sourceline 61
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Current path
* @member PIXI.Graphics#currentPath
* @type {Object}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
2015-03-23 23:46:30 +00:00
* @sourceline 70
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Array containing some WebGL-related properties used by the WebGL renderer.
* @member PIXI.Graphics#_webGL
* @type {Array}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
2015-03-23 23:46:30 +00:00
* @sourceline 79
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Whether this shape is being used as a mask.
* @member PIXI.Graphics#isMask
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
2015-03-23 23:46:30 +00:00
* @sourceline 88
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description The bounds' padding used for bounds calculation.
* @member PIXI.Graphics#boundsPadding
2014-11-15 20:01:46 +00:00
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
2015-03-23 23:46:30 +00:00
* @sourceline 96
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Used to detect if the graphics object has changed. If this is set to true then the graphics object will be recalculated.
* @member PIXI.Graphics#dirty
* @type {Boolean}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
2015-03-23 23:46:30 +00:00
* @sourceline 106
2014-11-15 20:01:46 +00:00
*/
/**
2016-08-26 00:18:47 +00:00
* @description Used to detect if the bounds have been invalidated, by this Graphics being cleared or drawn to.
If this is set to true then the updateLocalBounds is called once in the postUpdate method.
* @member PIXI.Graphics#_boundsDirty
* @type {Boolean}
* @access private
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 115
*/
/**
2015-03-23 23:46:30 +00:00
* @description Used to detect if the webgl graphics object has changed. If this is set to true then the graphics object will be recalculated.
* @member PIXI.Graphics#webGLDirty
* @type {Boolean}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 125
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Used to detect if the cached sprite object needs to be updated.
* @member PIXI.Graphics#cachedSpriteDirty
* @type {Boolean}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 134
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Specifies the line style used for subsequent calls to Graphics methods such as the lineTo() method or the drawCircle() method.
* @method PIXI.Graphics#lineStyle
* @param {Number} lineWidth - width of the line to draw, will update the objects stored style
* @param {Number} color - color of the line to draw, will update the objects stored style
* @param {Number} alpha - alpha of the line to draw, will update the objects stored style
* @return {PIXI.Graphics}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 149
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Moves the current drawing position to x, y.
* @method PIXI.Graphics#moveTo
* @param {Number} x - the X coordinate to move to
* @param {Number} y - the Y coordinate to move to
* @return {PIXI.Graphics}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 183
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description 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).
* @method PIXI.Graphics#lineTo
* @param {Number} x - the X coordinate to draw to
* @param {Number} y - the Y coordinate to draw to
* @return {PIXI.Graphics}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 198
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Calculate the points for a quadratic bezier curve and then draws it.
Based on: https://stackoverflow.com/questions/785097/how-do-i-implement-a-bezier-curve-in-c
* @method PIXI.Graphics#quadraticCurveTo
* @param {Number} cpX - Control point x
* @param {Number} cpY - Control point y
* @param {Number} toX - Destination point x
* @param {Number} toY - Destination point y
* @return {PIXI.Graphics}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 221
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Calculate the points for a bezier curve and then draws it.
* @method PIXI.Graphics#bezierCurveTo
* @param {Number} cpX - Control point x
* @param {Number} cpY - Control point y
* @param {Number} cpX2 - Second Control point x
* @param {Number} cpY2 - Second Control point y
* @param {Number} toX - Destination point x
* @param {Number} toY - Destination point y
* @return {PIXI.Graphics}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 276
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description The arc method creates an arc/curve (used to create circles, or parts of circles).
* @method PIXI.Graphics#arc
* @param {Number} cx - The x-coordinate of the center of the circle
* @param {Number} cy - The y-coordinate of the center of the circle
* @param {Number} radius - The radius of the circle
* @param {Number} startAngle - The starting angle, in radians (0 is at the 3 o'clock position of the arc's circle)
* @param {Number} endAngle - The ending angle, in radians
* @param {Boolean} anticlockwise - Optional. Specifies whether the drawing should be counterclockwise or clockwise. False is default, and indicates clockwise, while true indicates counter-clockwise.
2016-02-08 17:01:36 +00:00
* @param {Number} segments - Optional. The number of segments to use when calculating the arc. The default is 40. If you need more fidelity use a higher number.
2015-03-23 23:46:30 +00:00
* @return {PIXI.Graphics}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 405
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Specifies a simple one-color fill that subsequent calls to other Graphics methods
(such as lineTo() or drawCircle()) use when drawing.
* @method PIXI.Graphics#beginFill
* @param {Number} color - the color of the fill
* @param {Number} alpha - the alpha of the fill
* @return {PIXI.Graphics}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 491
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.
* @method PIXI.Graphics#endFill
* @return {PIXI.Graphics}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 519
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @method PIXI.Graphics#drawRect
* @param {Number} x - The X coord of the top-left of the rectangle
* @param {Number} y - The Y coord of the top-left of the rectangle
* @param {Number} width - The width of the rectangle
* @param {Number} height - The height of the rectangle
* @return {PIXI.Graphics}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 534
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @method PIXI.Graphics#drawRoundedRect
* @param {Number} x - The X coord of the top-left of the rectangle
* @param {Number} y - The Y coord of the top-left of the rectangle
* @param {Number} width - The width of the rectangle
* @param {Number} height - The height of the rectangle
2015-07-22 14:31:30 +00:00
* @param {Number} radius - Radius of the rectangle corners. In WebGL this must be a value between 0 and 9.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 550
2014-11-15 20:01:46 +00:00
*/
/**
2015-07-22 14:31:30 +00:00
* @description Draws a circle.
* @method PIXI.Graphics#drawCircle
* @param {Number} x - The X coordinate of the center of the circle
* @param {Number} y - The Y coordinate of the center of the circle
* @param {Number} diameter - The diameter of the circle
* @return {PIXI.Graphics}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 565
2015-07-22 14:31:30 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Draws an ellipse.
* @method PIXI.Graphics#drawEllipse
* @param {Number} x - The X coordinate of the center of the ellipse
* @param {Number} y - The Y coordinate of the center of the ellipse
* @param {Number} width - The half width of the ellipse
* @param {Number} height - The half height of the ellipse
* @return {PIXI.Graphics}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 581
2014-11-15 20:01:46 +00:00
*/
/**
* @description Draws a polygon using the given path.
* @method PIXI.Graphics#drawPolygon
2015-07-22 14:31:30 +00:00
* @param {(Array|PhaserPolygon)} path - The path data used to construct the polygon. Can either be an array of points or a Phaser.Polygon object.
2014-11-15 20:01:46 +00:00
* @return {PIXI.Graphics}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 598
2014-11-15 20:01:46 +00:00
*/
/**
* @description Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.
* @method PIXI.Graphics#clear
* @return {PIXI.Graphics}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 633
2014-11-15 20:01:46 +00:00
*/
/**
* @description 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.
* @method PIXI.Graphics#generateTexture
2016-02-17 13:27:09 +00:00
* @param {Number} [resolution=1] - The resolution of the texture being generated
* @param {Number} [scaleMode=0] - Should be one of the PIXI.scaleMode consts
* @param {Number} [padding=0] - Add optional extra padding to the generated texture (default 0)
2014-11-15 20:01:46 +00:00
* @return {PIXI.Texture} a texture of the graphics object
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 654
2014-11-15 20:01:46 +00:00
*/
/**
* @description Renders the object using the WebGL renderer
* @method PIXI.Graphics#_renderWebGL
* @param {RenderSession} renderSession -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 690
2014-11-15 20:01:46 +00:00
*/
/**
* @description Renders the object using the Canvas renderer
* @method PIXI.Graphics#_renderCanvas
* @param {RenderSession} renderSession -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 769
2014-11-15 20:01:46 +00:00
*/
/**
* @description Retrieves the bounds of the graphic shape as a rectangle object
* @method PIXI.Graphics#getBounds
2015-03-23 23:46:30 +00:00
* @return {Rectangle} the rectangular bounding area
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 848
*/
/**
* @description Retrieves the non-global local bounds of the graphic shape as a rectangle. The calculation takes all visible children into consideration.
* @method PIXI.Graphics#getLocalBounds
* @return {Rectangle} The rectangular bounding area
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 936
2014-11-15 20:01:46 +00:00
*/
2015-03-26 02:38:46 +00:00
2014-11-15 20:01:46 +00:00
/**
* @description Update the bounds of the object
* @method PIXI.Graphics#updateLocalBounds
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 997
2014-11-15 20:01:46 +00:00
*/
/**
* @description Generates the cached sprite when the sprite has cacheAsBitmap = true
* @method PIXI.Graphics#_generateCachedSprite
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 1109
2014-11-15 20:01:46 +00:00
*/
/**
* @description Updates texture size based on canvas size
* @method PIXI.Graphics#updateCachedSpriteTexture
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 1149
2014-11-15 20:01:46 +00:00
*/
/**
* @description Destroys a previous cached sprite.
* @method PIXI.Graphics#destroyCachedSprite
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 1173
2014-11-15 20:01:46 +00:00
*/
/**
* @description Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.
* @method PIXI.Graphics#drawShape
2015-03-23 23:46:30 +00:00
* @param {(Circle|Rectangle|Ellipse|Line|Polygon)} shape - The Shape object to draw.
2014-11-15 20:01:46 +00:00
* @return {PIXI.GraphicsData} The generated GraphicsData object.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 1184
2015-03-23 23:46:30 +00:00
*/
/**
* @description When cacheAsBitmap is set to true the graphics object will be rendered as if it was a sprite.
This is useful if your graphics element does not change often, as it will speed up the rendering of the object in exchange for taking up texture memory.
It is also useful if you need the graphics object to be anti-aliased, because it will be rendered using canvas.
This is not recommended if you are constantly redrawing the graphics element.
* @member PIXI.Graphics#cacheAsBitmap
* @type {Boolean}
* @default false
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/Graphics.js
* @sourceline 1228
2014-11-15 20:01:46 +00:00
*/
/**
* @class PIXI.GraphicsData
* @description A GraphicsData object.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/GraphicsData.js
2015-03-26 02:38:46 +00:00
* @sourceline 1
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-26 02:38:46 +00:00
* @class
* @description A GraphicsData object.
* @param {Number} lineWidth - the width of the line to draw
* @param {Number} lineColor - the color of the line to draw
* @param {Number} lineAlpha - the alpha of the line to draw
* @param {Number} fillColor - the color of the fill
* @param {Number} fillAlpha - the alpha of the fill
* @param {Boolean} fill - whether or not the shape is filled with a colour
* @param {(Circle|Rectangle|Ellipse|Line|Polygon)} shape - The shape object to draw.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/GraphicsData.js
2015-03-26 02:38:46 +00:00
* @sourceline 23
*/
/**
* @fileoverview Creates a new GraphicsData object with the same values as this one.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/primitives/GraphicsData.js
2015-03-26 02:38:46 +00:00
* @sourceline 93
2014-11-15 20:01:46 +00:00
*/
/**
* @class PIXI.CanvasBuffer
* @description Creates a Canvas element of the given size.
* @param {Number} width - the width for the newly created canvas
* @param {Number} height - the height for the newly created canvas
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasBuffer.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
2015-03-26 02:38:46 +00:00
2014-11-15 20:01:46 +00:00
/**
* @description The width of the Canvas in pixels.
* @member PIXI.CanvasBuffer#width
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasBuffer.js
2014-11-15 20:01:46 +00:00
* @sourceline 15
*/
/**
* @description The height of the Canvas in pixels.
* @member PIXI.CanvasBuffer#height
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasBuffer.js
2014-11-15 20:01:46 +00:00
* @sourceline 23
*/
/**
* @description The Canvas object that belongs to this CanvasBuffer.
* @member PIXI.CanvasBuffer#canvas
* @type {HTMLCanvasElement}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasBuffer.js
2014-11-15 20:01:46 +00:00
* @sourceline 31
*/
/**
* @description A CanvasRenderingContext2D object representing a two-dimensional rendering context.
* @member PIXI.CanvasBuffer#context
* @type {CanvasRenderingContext2D}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasBuffer.js
2014-11-15 20:01:46 +00:00
* @sourceline 39
*/
/**
* @description Clears the canvas that was created by the CanvasBuffer class.
* @method PIXI.CanvasBuffer#clear
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasBuffer.js
2014-11-15 20:01:46 +00:00
* @sourceline 53
*/
/**
* @description Resizes the canvas to the specified width and height.
* @method PIXI.CanvasBuffer#resize
* @param {Number} width - the new width of the canvas
* @param {Number} height - the new height of the canvas
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasBuffer.js
2014-11-15 20:01:46 +00:00
* @sourceline 65
*/
/**
2015-08-24 14:43:45 +00:00
* @description Frees the canvas up for use again.
* @method PIXI.CanvasBuffer#destroy
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasBuffer.js
2015-08-24 14:43:45 +00:00
* @sourceline 78
*/
/**
2014-11-15 20:01:46 +00:00
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasMaskManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.CanvasMaskManager
* @description A set of functions used to handle masking.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasMaskManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @description This method adds it to the current stack of masks.
* @method PIXI.CanvasMaskManager#pushMask
* @param {Object} maskData - the maskData that will be pushed
* @param {Object} renderSession - The renderSession whose context will be used for this mask manager.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasMaskManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 17
*/
/**
* @description Restores the current drawing context to the state it was before the mask was applied.
* @method PIXI.CanvasMaskManager#popMask
* @param {Object} renderSession - The renderSession whose context will be used for this mask manager.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasMaskManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 49
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasTinter.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.CanvasTinter
* @description Utility methods for Sprite/Texture tinting.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasTinter.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @description Basically this method just needs a sprite and a color and tints the sprite with the given color.
* @method PIXI.CanvasTinter.getTintedTexture
* @param {PIXI.Sprite} sprite - the sprite to tint
* @param {Number} color - the color to use to tint the sprite with
* @return {HTMLCanvasElement} The tinted canvas
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasTinter.js
2015-07-22 14:31:30 +00:00
* @sourceline 13
2014-11-15 20:01:46 +00:00
*/
/**
* @description Tint a texture using the "multiply" operation.
* @method PIXI.CanvasTinter.tintWithMultiply
* @param {PIXI.Texture} texture - the texture to tint
* @param {Number} color - the color to use to tint the sprite with
* @param {HTMLCanvasElement} canvas - the current canvas
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasTinter.js
2015-07-22 14:31:30 +00:00
* @sourceline 31
2014-11-15 20:01:46 +00:00
*/
/**
* @description Tint a texture pixel per pixel.
* @method PIXI.CanvasTinter.tintPerPixel
* @param {PIXI.Texture} texture - the texture to tint
* @param {Number} color - the color to use to tint the sprite with
* @param {HTMLCanvasElement} canvas - the current canvas
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasTinter.js
2015-07-22 14:31:30 +00:00
* @sourceline 65
2015-01-06 06:57:25 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Checks if the browser correctly supports putImageData alpha channels.
* @method PIXI.CanvasTinter.checkInverseAlpha
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasTinter.js
2015-07-22 14:31:30 +00:00
* @sourceline 113
2015-01-06 06:57:25 +00:00
*/
/**
* @description If the browser isn't capable of handling tinting with alpha this will be false.
This property is only applicable if using tintWithPerPixel.
* @member PIXI.CanvasTinter.canHandleAlpha
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasTinter.js
2015-07-22 14:31:30 +00:00
* @sourceline 146
2014-11-15 20:01:46 +00:00
*/
/**
* @description Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method.
* @member PIXI.CanvasTinter.canUseMultiply
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasTinter.js
2015-07-22 14:31:30 +00:00
* @sourceline 156
2014-11-15 20:01:46 +00:00
*/
/**
* @description The tinting method that will be used.
* @method PIXI.CanvasTinter.tintMethod
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/utils/CanvasTinter.js
2015-07-22 14:31:30 +00:00
* @sourceline 165
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasGraphics.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.CanvasGraphics
* @description A set of functions used by the canvas renderer to draw the primitive graphics data.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasGraphics.js
2014-11-15 20:01:46 +00:00
* @sourceline 6
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.CanvasRenderer
* @description The CanvasRenderer draws the Stage and all its content onto a 2d canvas. This renderer should be used for browsers that do not support webGL.
Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :)
2015-10-15 11:06:38 +00:00
* @param {PhaserGame} game - A reference to the Phaser Game instance
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
2015-10-15 11:06:38 +00:00
* @member PIXI.CanvasRenderer#game - A reference to the Phaser Game instance.
* @type {PhaserGame}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 15
*/
/**
2014-11-15 20:01:46 +00:00
* @description The renderer type.
* @member PIXI.CanvasRenderer#type
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 25
2014-11-15 20:01:46 +00:00
*/
/**
* @description The resolution of the canvas.
* @member PIXI.CanvasRenderer#resolution
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 33
2014-11-15 20:01:46 +00:00
*/
/**
* @description This sets if the CanvasRenderer will clear the canvas or not before the new render pass.
If the Stage is NOT transparent Pixi will use a canvas sized fillRect operation every frame to set the canvas background color.
If the Stage is transparent Pixi will use clearRect to clear the canvas every frame.
Disable this by setting this to false. For example if your game has a canvas filling background image you often don't need this set.
* @member PIXI.CanvasRenderer#clearBeforeRender
* @type {Boolean}
* @default
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 41
2014-11-15 20:01:46 +00:00
*/
/**
* @description Whether the render view is transparent
* @member PIXI.CanvasRenderer#transparent
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 53
2014-11-15 20:01:46 +00:00
*/
/**
* @description Whether the render view should be resized automatically
* @member PIXI.CanvasRenderer#autoResize
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 61
2014-11-15 20:01:46 +00:00
*/
/**
* @description The width of the canvas view
* @member PIXI.CanvasRenderer#width
* @type {Number}
* @default 800
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 69
2014-11-15 20:01:46 +00:00
*/
/**
* @description The height of the canvas view
* @member PIXI.CanvasRenderer#height
* @type {Number}
* @default 600
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 78
2014-11-15 20:01:46 +00:00
*/
/**
* @description The canvas element that everything is drawn to.
* @member PIXI.CanvasRenderer#view
* @type {HTMLCanvasElement}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 87
2014-11-15 20:01:46 +00:00
*/
/**
* @description The canvas 2d context that everything is drawn with
* @member PIXI.CanvasRenderer#context
* @type {CanvasRenderingContext2D}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 95
2014-11-15 20:01:46 +00:00
*/
/**
* @description Boolean flag controlling canvas refresh.
* @member PIXI.CanvasRenderer#refresh
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 102
2014-11-15 20:01:46 +00:00
*/
/**
* @description Internal var.
* @member PIXI.CanvasRenderer#count
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2016-05-19 11:36:51 +00:00
* @sourceline 110
2014-11-15 20:01:46 +00:00
*/
/**
* @description Instance of a PIXI.CanvasMaskManager, handles masking when using the canvas renderer
* @member PIXI.CanvasRenderer#CanvasMaskManager
* @type {PIXI.CanvasMaskManager}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2016-05-19 11:36:51 +00:00
* @sourceline 118
2014-11-15 20:01:46 +00:00
*/
/**
* @description The render session is just a bunch of parameter used for rendering
* @member PIXI.CanvasRenderer#renderSession
* @type {Object}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2016-05-19 11:36:51 +00:00
* @sourceline 125
2014-11-15 20:01:46 +00:00
*/
/**
2016-08-26 00:18:47 +00:00
* @description Renders the DisplayObjectContainer, usually the Phaser.Stage, to this canvas view.
2014-11-15 20:01:46 +00:00
* @method PIXI.CanvasRenderer#render
2016-08-26 00:18:47 +00:00
* @param {(PhaserStage|PIXIDisplayObjectContainer)} root - The root element to be rendered.
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
2016-05-19 11:36:51 +00:00
* @sourceline 152
2014-11-15 20:01:46 +00:00
*/
/**
* @description Removes everything from the renderer and optionally removes the Canvas DOM element.
* @method PIXI.CanvasRenderer#destroy
* @param {Boolean} [removeView=true] - Removes the Canvas element from the DOM.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
* @sourceline 194
2014-11-15 20:01:46 +00:00
*/
/**
* @description Resizes the canvas view to the specified width and height
* @method PIXI.CanvasRenderer#resize
* @param {Number} width - the new width of the canvas view
* @param {Number} height - the new height of the canvas view
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
* @sourceline 216
2014-11-15 20:01:46 +00:00
*/
/**
* @description Renders a display object
* @method PIXI.CanvasRenderer#renderDisplayObject
2016-07-01 15:57:13 +00:00
* @param {DisplayObject} displayObject - The displayObject to render
2014-11-15 20:01:46 +00:00
* @param {CanvasRenderingContext2D} context - the context 2d method of the canvas
2015-07-22 14:31:30 +00:00
* @param {Matrix} [matrix] - Optional matrix to apply to the display object before rendering.
2014-11-15 20:01:46 +00:00
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
* @sourceline 244
2014-11-15 20:01:46 +00:00
*/
/**
* @description Maps Pixi blend modes to canvas blend modes.
* @method PIXI.CanvasRenderer#mapBlendModes
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/canvas/CanvasRenderer.js
* @sourceline 261
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/ComplexPrimitiveShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.ComplexPrimitiveShader
* @param {WebGLContext} gl - the current WebGL drawing context
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/ComplexPrimitiveShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @member PIXI.ComplexPrimitiveShader#_UID
* @type {Number}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/ComplexPrimitiveShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 12
*/
/**
* @member PIXI.ComplexPrimitiveShader#gl
* @type {WebGLContext}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/ComplexPrimitiveShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 19
*/
/**
* @description The WebGL program.
* @member PIXI.ComplexPrimitiveShader#program
* @type {}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/ComplexPrimitiveShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 25
*/
/**
* @description The fragment shader.
* @member PIXI.ComplexPrimitiveShader#fragmentSrc
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/ComplexPrimitiveShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 32
*/
/**
* @description The vertex shader.
* @member PIXI.ComplexPrimitiveShader#vertexSrc
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/ComplexPrimitiveShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 48
*/
/**
* @description Initialises the shader.
* @method PIXI.ComplexPrimitiveShader#init
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/ComplexPrimitiveShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 79
*/
/**
* @description Destroys the shader.
* @method PIXI.ComplexPrimitiveShader#destroy
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/ComplexPrimitiveShader.js
2015-01-06 06:57:25 +00:00
* @sourceline 110
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiFastShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.PixiFastShader
* @param {WebGLContext} gl - the current WebGL drawing context
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiFastShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @member PIXI.PixiFastShader#_UID
* @type {Number}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiFastShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 12
*/
/**
* @member PIXI.PixiFastShader#gl
* @type {WebGLContext}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiFastShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 19
*/
/**
* @description The WebGL program.
* @member PIXI.PixiFastShader#program
* @type {}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiFastShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 25
*/
/**
* @description The fragment shader.
* @member PIXI.PixiFastShader#fragmentSrc
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiFastShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 32
*/
/**
* @description The vertex shader.
* @member PIXI.PixiFastShader#vertexSrc
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiFastShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 47
*/
/**
* @description A local texture counter for multi-texture shaders.
* @member PIXI.PixiFastShader#textureCount
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiFastShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 82
*/
/**
* @description Initialises the shader.
* @method PIXI.PixiFastShader#init
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiFastShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 94
*/
/**
* @description Destroys the shader.
* @method PIXI.PixiFastShader#destroy
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiFastShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 143
*/
/**
* @fileoverview
* @author Richard Davey http://www.photonstorm.com @photonstorm
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.PixiShader
* @param {WebGLContext} gl - the current WebGL drawing context
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 6
*/
/**
* @member PIXI.PixiShader#_UID
* @type {Number}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 13
*/
/**
* @member PIXI.PixiShader#gl
* @type {WebGLContext}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 20
*/
/**
* @description The WebGL program.
* @member PIXI.PixiShader#program
* @type {}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 26
*/
/**
* @description The fragment shader.
* @member PIXI.PixiShader#fragmentSrc
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 33
*/
/**
* @description A local texture counter for multi-texture shaders.
* @member PIXI.PixiShader#textureCount
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 48
*/
/**
* @description A local flag
* @member PIXI.PixiShader#firstRun
* @type {Boolean}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 55
*/
/**
* @description A dirty flag
* @member PIXI.PixiShader#dirty
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 63
*/
/**
* @description Uniform attributes cache.
* @member PIXI.PixiShader#attributes
* @type {Array}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 70
*/
/**
* @description Initialises the shader.
* @method PIXI.PixiShader#init
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 83
*/
/**
* @description Initialises the shader uniform values.
Uniforms are specified in the GLSL_ES Specification: http://www.khronos.org/registry/webgl/specs/latest/1.0/
http://www.khronos.org/registry/gles/specs/2.0/GLSL_ES_Specification_1.0.17.pdf
* @method PIXI.PixiShader#initUniforms
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 134
*/
/**
* @description Initialises a Sampler2D uniform (which may only be available later on after initUniforms once the texture has loaded)
* @method PIXI.PixiShader#initSampler2D
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 208
*/
/**
* @description Updates the shader uniform values.
* @method PIXI.PixiShader#syncUniforms
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 283
*/
/**
* @description Destroys the shader.
* @method PIXI.PixiShader#destroy
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 351
*/
/**
* @description The Default Vertex shader source.
* @member PIXI.PixiShader#defaultVertexSrc
* @type {String}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PixiShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 365
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PrimitiveShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.PrimitiveShader
* @param {WebGLContext} gl - the current WebGL drawing context
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PrimitiveShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @member PIXI.PrimitiveShader#_UID
* @type {Number}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PrimitiveShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 12
*/
/**
* @member PIXI.PrimitiveShader#gl
* @type {WebGLContext}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PrimitiveShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 19
*/
/**
* @description The WebGL program.
* @member PIXI.PrimitiveShader#program
* @type {}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PrimitiveShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 25
*/
/**
* @description The fragment shader.
* @member PIXI.PrimitiveShader#fragmentSrc
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PrimitiveShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 32
*/
/**
* @description The vertex shader.
* @member PIXI.PrimitiveShader#vertexSrc
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PrimitiveShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 46
*/
/**
* @description Initialises the shader.
* @method PIXI.PrimitiveShader#init
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PrimitiveShader.js
2015-01-06 06:57:25 +00:00
* @sourceline 75
2014-11-15 20:01:46 +00:00
*/
/**
* @description Destroys the shader.
* @method PIXI.PrimitiveShader#destroy
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/PrimitiveShader.js
2015-01-06 06:57:25 +00:00
* @sourceline 105
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/StripShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.StripShader
* @param {WebGLContext} gl - the current WebGL drawing context
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/StripShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @member PIXI.StripShader#_UID
* @type {Number}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/StripShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 12
*/
/**
* @member PIXI.StripShader#gl
* @type {WebGLContext}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/StripShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 19
*/
/**
* @description The WebGL program.
* @member PIXI.StripShader#program
* @type {}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/StripShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 25
*/
/**
* @description The fragment shader.
* @member PIXI.StripShader#fragmentSrc
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/StripShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 32
*/
/**
* @description The vertex shader.
* @member PIXI.StripShader#vertexSrc
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/StripShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 50
*/
/**
* @description Initialises the shader.
* @method PIXI.StripShader#init
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/StripShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 80
*/
/**
* @description Destroys the shader.
* @method PIXI.StripShader#destroy
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/shaders/StripShader.js
2014-11-15 20:01:46 +00:00
* @sourceline 111
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/FilterTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.FilterTexture
* @param {WebGLContext} gl - the current WebGL drawing context
* @param {Number} width - the horizontal range of the filter
* @param {Number} height - the vertical range of the filter
* @param {Number} scaleMode - See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/FilterTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @member PIXI.FilterTexture#gl
* @type {WebGLContext}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/FilterTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 15
*/
/**
* @member PIXI.FilterTexture#frameBuffer
* @type {}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/FilterTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 23
*/
/**
* @member PIXI.FilterTexture#texture
* @type {}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/FilterTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 29
*/
/**
* @member PIXI.FilterTexture#scaleMode
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/FilterTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 35
*/
/**
* @description Clears the filter texture.
* @method PIXI.FilterTexture#clear
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/FilterTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 61
*/
/**
* @description Resizes the texture to the specified width and height
* @method PIXI.FilterTexture#resize
* @param {Number} width - the new width of the texture
* @param {Number} height - the new height of the texture
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/FilterTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 74
*/
/**
* @description Destroys the filter texture.
* @method PIXI.FilterTexture#destroy
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/FilterTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 97
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLBlendModeManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.WebGLBlendModeManager
* @param {WebGLContext} gl - the current WebGL drawing context
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLBlendModeManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @member PIXI.WebGLBlendModeManager#currentBlendMode
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLBlendModeManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 12
*/
/**
* @description Sets the WebGL Context.
* @method PIXI.WebGLBlendModeManager#setContext
* @param {WebGLContext} gl - the current WebGL drawing context
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLBlendModeManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 21
*/
/**
* @description Sets-up the given blendMode from WebGL's point of view.
* @method PIXI.WebGLBlendModeManager#setBlendMode
* @param {Number} blendMode - the blendMode, should be a Pixi const, such as PIXI.BlendModes.ADD
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLBlendModeManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 32
*/
/**
* @description Destroys this object.
* @method PIXI.WebGLBlendModeManager#destroy
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLBlendModeManager.js
2015-10-15 11:06:38 +00:00
* @sourceline 54
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves
Big thanks to the very clever Matt DesLauriers < mattdesl> https://github.com/mattdesl/
for creating the original pixi version!
Heavily inspired by LibGDX's WebGLSpriteBatch:
https://github.com/libgdx/libgdx/blob/master/gdx/src/com/badlogic/gdx/graphics/g2d/WebGLSpriteBatch.java
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.WebGLFastSpriteBatch
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 11
*/
/**
* @member PIXI.WebGLFastSpriteBatch#vertSize
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 17
*/
/**
* @member PIXI.WebGLFastSpriteBatch#maxSize
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 23
*/
/**
* @member PIXI.WebGLFastSpriteBatch#size
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 29
*/
/**
* @description Vertex data
* @member PIXI.WebGLFastSpriteBatch#vertices
* @type {Float32Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 41
*/
/**
* @description Index data
* @member PIXI.WebGLFastSpriteBatch#indices
* @type {Uint16Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 48
*/
/**
* @member PIXI.WebGLFastSpriteBatch#vertexBuffer
* @type {Object}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 55
*/
/**
* @member PIXI.WebGLFastSpriteBatch#indexBuffer
* @type {Object}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 61
*/
/**
* @member PIXI.WebGLFastSpriteBatch#lastIndexCount
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 67
*/
/**
* @member PIXI.WebGLFastSpriteBatch#drawing
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 83
*/
/**
* @member PIXI.WebGLFastSpriteBatch#currentBatchSize
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 89
*/
/**
* @member PIXI.WebGLFastSpriteBatch#currentBaseTexture
* @type {PIXI.BaseTexture}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 95
*/
/**
* @member PIXI.WebGLFastSpriteBatch#currentBlendMode
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 101
*/
/**
* @member PIXI.WebGLFastSpriteBatch#renderSession
* @type {Object}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 107
*/
/**
* @member PIXI.WebGLFastSpriteBatch#shader
* @type {Object}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 113
*/
/**
* @member PIXI.WebGLFastSpriteBatch#matrix
2015-03-23 23:46:30 +00:00
* @type {Matrix}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 119
*/
/**
* @description Sets the WebGL Context.
* @method PIXI.WebGLFastSpriteBatch#setContext
* @param {WebGLContext} gl - the current WebGL drawing context
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 130
*/
/**
* @method PIXI.WebGLFastSpriteBatch#begin
* @param {PIXI.WebGLSpriteBatch} spriteBatch -
* @param {Object} renderSession -
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 154
*/
/**
* @method PIXI.WebGLFastSpriteBatch#end
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 169
*/
/**
* @method PIXI.WebGLFastSpriteBatch#render
* @param {PIXI.WebGLSpriteBatch} spriteBatch -
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 177
*/
/**
* @method PIXI.WebGLFastSpriteBatch#renderSprite
* @param {PIXI.Sprite} sprite -
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 208
*/
/**
* @method PIXI.WebGLFastSpriteBatch#flush
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 349
*/
/**
* @method PIXI.WebGLFastSpriteBatch#stop
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 389
*/
/**
* @method PIXI.WebGLFastSpriteBatch#start
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFastSpriteBatch.js
2014-11-15 20:01:46 +00:00
* @sourceline 397
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFilterManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.WebGLFilterManager
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFilterManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @member PIXI.WebGLFilterManager#filterStack
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFilterManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 11
*/
/**
* @member PIXI.WebGLFilterManager#offsetX
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFilterManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 17
*/
/**
* @member PIXI.WebGLFilterManager#offsetY
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFilterManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 23
*/
/**
* @description Initialises the context and the properties.
* @method PIXI.WebGLFilterManager#setContext
* @param {WebGLContext} gl - the current WebGL drawing context
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFilterManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 32
*/
/**
* @method PIXI.WebGLFilterManager#begin
* @param {RenderSession} renderSession -
* @param {ArrayBuffer} buffer -
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFilterManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 46
*/
/**
* @description Applies the filter and adds it to the current filter stack.
* @method PIXI.WebGLFilterManager#pushFilter
* @param {Object} filterBlock - the filter that will be pushed to the current filter stack
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFilterManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 62
*/
/**
* @description Removes the last filter from the filter stack and doesn't return it.
* @method PIXI.WebGLFilterManager#popFilter
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFilterManager.js
2016-02-08 17:01:36 +00:00
* @sourceline 145
2014-11-15 20:01:46 +00:00
*/
/**
* @description Applies the filter to the specified area.
* @method PIXI.WebGLFilterManager#applyFilterPass
* @param {PIXI.AbstractFilter} filter - the filter that needs to be applied
* @param {PIXI.Texture} filterArea - TODO - might need an update
* @param {Number} width - the horizontal range of the filter
* @param {Number} height - the vertical range of the filter
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFilterManager.js
2016-02-08 17:01:36 +00:00
* @sourceline 336
2014-11-15 20:01:46 +00:00
*/
/**
* @description Initialises the shader buffers.
* @method PIXI.WebGLFilterManager#initShaderBuffers
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFilterManager.js
2016-02-08 17:01:36 +00:00
* @sourceline 397
2014-11-15 20:01:46 +00:00
*/
/**
* @description Destroys the filter and removes it from the filter stack.
* @method PIXI.WebGLFilterManager#destroy
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLFilterManager.js
2016-02-08 17:01:36 +00:00
* @sourceline 445
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLGraphics.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.WebGLGraphics
* @description A set of functions used by the webGL renderer to draw the primitive graphics data
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLGraphics.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
2016-02-08 17:01:36 +00:00
2014-11-15 20:01:46 +00:00
/**
* @description Renders the graphics object
* @method PIXI.WebGLGraphics.renderGraphics
* @param {PIXI.Graphics} graphics -
* @param {Object} renderSession -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLGraphics.js
2016-02-08 17:01:36 +00:00
* @sourceline 23
2014-11-15 20:01:46 +00:00
*/
/**
* @description Updates the graphics object
* @method PIXI.WebGLGraphics.updateGraphics
* @param {PIXI.Graphics} graphicsData - The graphics object to update
* @param {WebGLContext} gl - the current WebGL drawing context
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLGraphics.js
2016-02-08 17:01:36 +00:00
* @sourceline 93
2014-11-15 20:01:46 +00:00
*/
/**
* @method PIXI.WebGLGraphics.switchMode
* @param {WebGLContext} webGL -
* @param {Number} type -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLGraphics.js
2016-02-08 17:01:36 +00:00
* @sourceline 218
2014-11-15 20:01:46 +00:00
*/
/**
* @description Builds a rectangle to draw
* @method PIXI.WebGLGraphics.buildRectangle
* @param {PIXI.Graphics} graphicsData - The graphics object containing all the necessary properties
* @param {Object} webGLData -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLGraphics.js
2016-02-08 17:01:36 +00:00
* @sourceline 252
2014-11-15 20:01:46 +00:00
*/
/**
* @description Builds a rounded rectangle to draw
* @method PIXI.WebGLGraphics.buildRoundedRectangle
* @param {PIXI.Graphics} graphicsData - The graphics object containing all the necessary properties
* @param {Object} webGLData -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLGraphics.js
2016-02-08 17:01:36 +00:00
* @sourceline 320
2014-11-15 20:01:46 +00:00
*/
/**
* @description Calculate the points for a quadratic bezier curve. (helper function..)
Based on: https://stackoverflow.com/questions/785097/how-do-i-implement-a-bezier-curve-in-c
* @method PIXI.WebGLGraphics.quadraticBezierCurve
* @param {Number} fromX - Origin point x
* @param {Number} fromY - Origin point x
* @param {Number} cpX - Control point x
* @param {Number} cpY - Control point y
* @param {Number} toX - Destination point x
* @param {Number} toY - Destination point y
* @return {Array< Number>}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLGraphics.js
2016-02-08 17:01:36 +00:00
* @sourceline 390
2014-11-15 20:01:46 +00:00
*/
/**
* @description Builds a circle to draw
* @method PIXI.WebGLGraphics.buildCircle
* @param {PIXI.Graphics} graphicsData - The graphics object to draw
* @param {Object} webGLData -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLGraphics.js
2016-02-08 17:01:36 +00:00
* @sourceline 442
2014-11-15 20:01:46 +00:00
*/
/**
* @description Builds a line to draw
* @method PIXI.WebGLGraphics.buildLine
* @param {PIXI.Graphics} graphicsData - The graphics object containing all the necessary properties
* @param {Object} webGLData -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLGraphics.js
2016-02-08 17:01:36 +00:00
* @sourceline 525
2014-11-15 20:01:46 +00:00
*/
/**
* @description Builds a complex polygon to draw
* @method PIXI.WebGLGraphics.buildComplexPoly
* @param {PIXI.Graphics} graphicsData - The graphics object containing all the necessary properties
* @param {Object} webGLData -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLGraphics.js
2016-02-08 17:01:36 +00:00
* @sourceline 737
2014-11-15 20:01:46 +00:00
*/
/**
* @description Builds a polygon to draw
* @method PIXI.WebGLGraphics.buildPoly
* @param {PIXI.Graphics} graphicsData - The graphics object containing all the necessary properties
* @param {Object} webGLData -
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLGraphics.js
2016-02-08 17:01:36 +00:00
* @sourceline 799
2014-11-15 20:01:46 +00:00
*/
/**
* @class PIXI.WebGLGraphicsData
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLGraphics.js
2016-02-08 17:01:36 +00:00
* @sourceline 854
2014-11-15 20:01:46 +00:00
*/
/**
* @method PIXI.WebGLGraphicsData#reset
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLGraphics.js
2016-02-08 17:01:36 +00:00
* @sourceline 874
2014-11-15 20:01:46 +00:00
*/
/**
* @method PIXI.WebGLGraphicsData#upload
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLGraphics.js
2016-02-08 17:01:36 +00:00
* @sourceline 883
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLMaskManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.WebGLMaskManager
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLMaskManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @description Sets the drawing context to the one given in parameter.
* @method PIXI.WebGLMaskManager#setContext
* @param {WebGLContext} gl - the current WebGL drawing context
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLMaskManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 16
*/
/**
* @description Applies the Mask and adds it to the current filter stack.
* @method PIXI.WebGLMaskManager#pushMask
* @param {Array} maskData -
* @param {Object} renderSession -
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLMaskManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 27
*/
/**
* @description Removes the last filter from the filter stack and doesn't return it.
* @method PIXI.WebGLMaskManager#popMask
* @param {Array} maskData -
* @param {Object} renderSession - an object containing all the useful parameters
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLMaskManager.js
2016-02-08 17:01:36 +00:00
* @sourceline 51
2014-11-15 20:01:46 +00:00
*/
/**
* @description Destroys the mask stack.
* @method PIXI.WebGLMaskManager#destroy
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLMaskManager.js
2016-02-08 17:01:36 +00:00
* @sourceline 71
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLShaderManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.WebGLShaderManager
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLShaderManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @member PIXI.WebGLShaderManager#maxAttibs
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLShaderManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 12
*/
/**
* @member PIXI.WebGLShaderManager#attribState
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLShaderManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 18
*/
/**
* @member PIXI.WebGLShaderManager#tempAttribState
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLShaderManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 24
*/
/**
* @member PIXI.WebGLShaderManager#stack
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLShaderManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 35
*/
/**
* @description Initialises the context and the properties.
* @method PIXI.WebGLShaderManager#setContext
* @param {WebGLContext} gl - the current WebGL drawing context
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLShaderManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 45
*/
/**
* @description Takes the attributes given in parameters.
* @method PIXI.WebGLShaderManager#setAttribs
* @param {Array} attribs - attribs
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLShaderManager.js
2016-05-19 11:36:51 +00:00
* @sourceline 73
2014-11-15 20:01:46 +00:00
*/
/**
* @description Sets the current shader.
* @method PIXI.WebGLShaderManager#setShader
* @param {} shader -
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLShaderManager.js
2016-05-19 11:36:51 +00:00
* @sourceline 116
2014-11-15 20:01:46 +00:00
*/
/**
* @description Destroys this object.
* @method PIXI.WebGLShaderManager#destroy
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLShaderManager.js
2016-05-19 11:36:51 +00:00
* @sourceline 136
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLShaderUtils.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.WebGLSpriteBatch
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 12
2014-11-15 20:01:46 +00:00
*/
/**
* @method PIXI.WebGLSpriteBatch.initDefaultShaders
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLShaderUtils.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @method PIXI.WebGLSpriteBatch.CompileVertexShader
* @param {WebGLContext} gl - the current WebGL drawing context
* @param {Array} shaderSrc -
* @return {}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLShaderUtils.js
2014-11-15 20:01:46 +00:00
* @sourceline 14
*/
/**
* @method PIXI.WebGLSpriteBatch.CompileFragmentShader
* @param {WebGLContext} gl - the current WebGL drawing context
* @param {Array} shaderSrc -
* @return {}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLShaderUtils.js
2014-11-15 20:01:46 +00:00
* @sourceline 26
*/
/**
* @method PIXI.WebGLSpriteBatch._CompileShader
* @param {WebGLContext} gl - the current WebGL drawing context
* @param {Array} shaderSrc -
* @param {Number} shaderType -
* @return {}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLShaderUtils.js
2014-11-15 20:01:46 +00:00
* @sourceline 38
*/
/**
* @method PIXI.WebGLSpriteBatch.compileProgram
* @param {WebGLContext} gl - the current WebGL drawing context
* @param {Array} vertexSrc -
* @param {Array} fragmentSrc -
* @return {}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLShaderUtils.js
2015-07-22 14:31:30 +00:00
* @sourceline 69
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.WebGLSpriteBatch#vertSize
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 20
2014-11-15 20:01:46 +00:00
*/
/**
* @description The number of images in the SpriteBatch before it flushes
* @member PIXI.WebGLSpriteBatch#size
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 26
2014-11-15 20:01:46 +00:00
*/
/**
* @description Holds the vertices
* @member PIXI.WebGLSpriteBatch#vertices
2014-12-03 10:39:11 +00:00
* @type {ArrayBuffer}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 38
*/
/**
* @description View on the vertices as a Float32Array
* @member PIXI.WebGLSpriteBatch#positions
2014-11-15 20:01:46 +00:00
* @type {Float32Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 46
*/
/**
* @description View on the vertices as a Uint32Array
* @member PIXI.WebGLSpriteBatch#colors
* @type {Uint32Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 54
2014-11-15 20:01:46 +00:00
*/
/**
* @description Holds the indices
* @member PIXI.WebGLSpriteBatch#indices
* @type {Uint16Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 62
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.WebGLSpriteBatch#lastIndexCount
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 70
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.WebGLSpriteBatch#drawing
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 86
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.WebGLSpriteBatch#currentBatchSize
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 92
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.WebGLSpriteBatch#currentBaseTexture
* @type {PIXI.BaseTexture}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 98
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.WebGLSpriteBatch#dirty
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 104
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.WebGLSpriteBatch#textures
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 110
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.WebGLSpriteBatch#blendModes
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 116
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.WebGLSpriteBatch#shaders
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 122
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.WebGLSpriteBatch#sprites
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 128
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.WebGLSpriteBatch#defaultShader
* @type {PIXI.AbstractFilter}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 134
2014-11-15 20:01:46 +00:00
*/
/**
* @method PIXI.WebGLSpriteBatch#setContext
* @param {WebGLContext} gl - the current WebGL drawing context
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 149
2014-11-15 20:01:46 +00:00
*/
/**
* @method PIXI.WebGLSpriteBatch#begin
* @param {Object} renderSession - The RenderSession object
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 181
2014-11-15 20:01:46 +00:00
*/
/**
* @method PIXI.WebGLSpriteBatch#end
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 193
2014-11-15 20:01:46 +00:00
*/
/**
* @method PIXI.WebGLSpriteBatch#render
* @param {PIXI.Sprite} sprite - the sprite to render when using this spritebatch
2015-07-22 14:31:30 +00:00
* @param {Matrix} [matrix] - - Optional matrix. If provided the Display Object will be rendered using this matrix, otherwise it will use its worldTransform.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2014-12-03 10:39:11 +00:00
* @sourceline 201
2014-11-15 20:01:46 +00:00
*/
/**
* @description Renders a TilingSprite using the spriteBatch.
* @method PIXI.WebGLSpriteBatch#renderTilingSprite
2015-07-22 14:31:30 +00:00
* @param {PIXI.TilingSprite} sprite - the sprite to render
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2015-07-22 14:31:30 +00:00
* @sourceline 335
2014-11-15 20:01:46 +00:00
*/
/**
* @description Renders the content and empties the current batch.
* @method PIXI.WebGLSpriteBatch#flush
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2015-07-22 14:31:30 +00:00
* @sourceline 462
2014-11-15 20:01:46 +00:00
*/
/**
* @method PIXI.WebGLSpriteBatch#renderBatch
* @param {PIXI.Texture} texture -
* @param {Number} size -
* @param {Number} startIndex -
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2016-02-08 17:01:36 +00:00
* @sourceline 610
2014-11-15 20:01:46 +00:00
*/
/**
* @method PIXI.WebGLSpriteBatch#stop
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2016-02-08 17:01:36 +00:00
* @sourceline 647
2014-11-15 20:01:46 +00:00
*/
/**
* @method PIXI.WebGLSpriteBatch#start
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2016-02-08 17:01:36 +00:00
* @sourceline 656
2014-11-15 20:01:46 +00:00
*/
/**
* @description Destroys the SpriteBatch.
* @method PIXI.WebGLSpriteBatch#destroy
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js
2016-02-08 17:01:36 +00:00
* @sourceline 664
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLStencilManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.WebGLStencilManager
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLStencilManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @description Sets the drawing context to the one given in parameter.
* @method PIXI.WebGLStencilManager#setContext
* @param {WebGLContext} gl - the current WebGL drawing context
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLStencilManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 17
*/
/**
* @description Applies the Mask and adds it to the current filter stack.
* @method PIXI.WebGLStencilManager#pushMask
* @param {PIXI.Graphics} graphics -
* @param {Array} webGLData -
* @param {Object} renderSession -
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLStencilManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 28
*/
/**
* @description TODO this does not belong here!
* @method PIXI.WebGLStencilManager#bindGraphics
* @param {PIXI.Graphics} graphics -
* @param {Array} webGLData -
* @param {Object} renderSession -
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLStencilManager.js
2014-11-15 20:01:46 +00:00
* @sourceline 120
*/
/**
* @method PIXI.WebGLStencilManager#popStencil
* @param {PIXI.Graphics} graphics -
* @param {Array} webGLData -
* @param {Object} renderSession -
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLStencilManager.js
2015-01-06 06:57:25 +00:00
* @sourceline 193
2014-11-15 20:01:46 +00:00
*/
/**
* @description Destroys the mask stack.
* @method PIXI.WebGLStencilManager#destroy
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/utils/WebGLStencilManager.js
2015-01-06 06:57:25 +00:00
* @sourceline 288
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.WebGLRenderer
* @description The WebGLRenderer draws the stage and all its content onto a webGL enabled canvas. This renderer
should be used for browsers that support webGL. This Render works by automatically managing webGLBatchs.
So no need for Sprite Batches or Sprite Clouds.
Don't forget to add the view to your DOM or you will not see anything :)
2015-10-15 11:06:38 +00:00
* @param {PhaserGame} game - A reference to the Phaser Game instance
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2014-11-15 20:01:46 +00:00
* @sourceline 8
*/
/**
2015-10-15 11:06:38 +00:00
* @member PIXI.WebGLRenderer#game - A reference to the Phaser Game instance.
* @type {PhaserGame}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 20
*/
/**
2014-11-15 20:01:46 +00:00
* @member PIXI.WebGLRenderer#type
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 30
2014-11-15 20:01:46 +00:00
*/
/**
* @description The resolution of the renderer
* @member PIXI.WebGLRenderer#resolution
* @type {Number}
* @default 1
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 36
2014-11-15 20:01:46 +00:00
*/
/**
* @description Whether the render view is transparent
* @member PIXI.WebGLRenderer#transparent
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 45
2014-11-15 20:01:46 +00:00
*/
/**
* @description Whether the render view should be resized automatically
* @member PIXI.WebGLRenderer#autoResize
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 53
2014-11-15 20:01:46 +00:00
*/
/**
* @description The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.
* @member PIXI.WebGLRenderer#preserveDrawingBuffer
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 61
2014-11-15 20:01:46 +00:00
*/
/**
* @description This sets if the WebGLRenderer will clear the context texture or not before the new render pass. If true:
If the Stage is NOT transparent, Pixi will clear to alpha (0, 0, 0, 0).
If the Stage is transparent, Pixi will clear to the target Stage's background color.
Disable this by setting this to false. For example: if your game has a canvas filling background image, you often don't need this set.
* @member PIXI.WebGLRenderer#clearBeforeRender
* @type {Boolean}
* @default
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 69
2014-11-15 20:01:46 +00:00
*/
/**
* @description The width of the canvas view
* @member PIXI.WebGLRenderer#width
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 81
2014-11-15 20:01:46 +00:00
*/
/**
* @description The height of the canvas view
* @member PIXI.WebGLRenderer#height
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 89
2014-11-15 20:01:46 +00:00
*/
/**
* @description The canvas element that everything is drawn to
* @member PIXI.WebGLRenderer#view
* @type {HTMLCanvasElement}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 97
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.WebGLRenderer#_contextOptions
* @type {Object}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 105
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.WebGLRenderer#projection
2015-03-23 23:46:30 +00:00
* @type {Point}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 118
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.WebGLRenderer#offset
2015-03-23 23:46:30 +00:00
* @type {Point}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 124
2014-11-15 20:01:46 +00:00
*/
/**
* @description Deals with managing the shader programs and their attribs
* @member PIXI.WebGLRenderer#shaderManager
* @type {PIXI.WebGLShaderManager}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 132
2014-11-15 20:01:46 +00:00
*/
/**
* @description Manages the rendering of sprites
* @member PIXI.WebGLRenderer#spriteBatch
* @type {PIXI.WebGLSpriteBatch}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 139
2014-11-15 20:01:46 +00:00
*/
/**
* @description Manages the masks using the stencil buffer
* @member PIXI.WebGLRenderer#maskManager
* @type {PIXI.WebGLMaskManager}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 146
2014-11-15 20:01:46 +00:00
*/
/**
* @description Manages the filters
* @member PIXI.WebGLRenderer#filterManager
* @type {PIXI.WebGLFilterManager}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 153
2014-11-15 20:01:46 +00:00
*/
/**
* @description Manages the stencil buffer
* @member PIXI.WebGLRenderer#stencilManager
* @type {PIXI.WebGLStencilManager}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 160
2014-11-15 20:01:46 +00:00
*/
/**
* @description Manages the blendModes
* @member PIXI.WebGLRenderer#blendModeManager
* @type {PIXI.WebGLBlendModeManager}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 167
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.WebGLRenderer#renderSession
* @type {Object}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 174
2014-11-15 20:01:46 +00:00
*/
/**
* @method PIXI.WebGLRenderer#initContext
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 204
2014-11-15 20:01:46 +00:00
*/
/**
* @description Renders the stage to its webGL view
* @method PIXI.WebGLRenderer#render
2015-10-15 11:06:38 +00:00
* @param {Stage} stage - the Stage element to be rendered
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2015-10-15 11:06:38 +00:00
* @sourceline 243
2014-11-15 20:01:46 +00:00
*/
/**
* @description Renders a Display Object.
* @method PIXI.WebGLRenderer#renderDisplayObject
2016-07-01 15:57:13 +00:00
* @param {DisplayObject} displayObject - The DisplayObject to render
2015-03-23 23:46:30 +00:00
* @param {Point} projection - The projection
2014-11-15 20:01:46 +00:00
* @param {Array} buffer - a standard WebGL buffer
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2016-06-03 17:48:34 +00:00
* @sourceline 278
2014-11-15 20:01:46 +00:00
*/
/**
* @description Resizes the webGL view to the specified width and height.
* @method PIXI.WebGLRenderer#resize
* @param {Number} width - the new width of the webGL view
* @param {Number} height - the new height of the webGL view
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2016-06-03 17:48:34 +00:00
* @sourceline 315
2014-11-15 20:01:46 +00:00
*/
/**
* @description Updates and Creates a WebGL texture for the renderers context.
* @method PIXI.WebGLRenderer#updateTexture
* @param {PIXI.Texture} texture - the texture to update
2015-10-15 11:06:38 +00:00
* @return {Boolean} True if the texture was successfully bound, otherwise false.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2016-06-03 17:48:34 +00:00
* @sourceline 341
2014-11-15 20:01:46 +00:00
*/
/**
* @description Removes everything from the renderer (event listeners, spritebatch, etc...)
* @method PIXI.WebGLRenderer#destroy
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2016-06-03 17:48:34 +00:00
* @sourceline 398
2014-11-15 20:01:46 +00:00
*/
/**
* @description Maps Pixi blend modes to WebGL blend modes.
* @method PIXI.WebGLRenderer#mapBlendModes
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/renderers/webgl/WebGLRenderer.js
2016-06-03 17:48:34 +00:00
* @sourceline 430
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.BaseTexture
* @description A texture stores the information that represents an image. All textures have a base texture.
2016-07-08 14:46:26 +00:00
* @param {(String|Canvas)} source - the source object (image or canvas)
2014-11-15 20:01:46 +00:00
* @param {Number} scaleMode - See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 5
2014-11-15 20:01:46 +00:00
*/
/**
* @description The Resolution of the texture.
* @member PIXI.BaseTexture#resolution
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 16
2014-11-15 20:01:46 +00:00
*/
/**
* @description [read-only] The width of the base texture set when the image has loaded
* @member PIXI.BaseTexture#width
* @type {Number}
* @readonly
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 24
2014-11-15 20:01:46 +00:00
*/
/**
* @description [read-only] The height of the base texture set when the image has loaded
* @member PIXI.BaseTexture#height
* @type {Number}
* @readonly
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 33
2014-11-15 20:01:46 +00:00
*/
/**
* @description The scale mode to apply when scaling this texture
* @member PIXI.BaseTexture#scaleMode
* @type {Number}
* @default PIXI.scaleModes.LINEAR
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 42
2014-11-15 20:01:46 +00:00
*/
/**
* @description [read-only] Set to true once the base texture has loaded
* @member PIXI.BaseTexture#hasLoaded
* @type {Boolean}
* @readonly
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 51
2014-11-15 20:01:46 +00:00
*/
/**
* @description The image source that is used to create the texture.
* @member PIXI.BaseTexture#source
* @type {Image}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 60
2014-11-15 20:01:46 +00:00
*/
/**
* @description Controls if RGB channels should be pre-multiplied by Alpha (WebGL only)
* @member PIXI.BaseTexture#premultipliedAlpha
* @type {Boolean}
* @default true
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 68
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.BaseTexture#_glTextures
* @type {Array}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 79
2014-11-15 20:01:46 +00:00
*/
/**
2014-12-03 10:39:11 +00:00
* @description Set this to true if a mipmap of this texture needs to be generated. This value needs to be set before the texture is used
2015-07-22 14:31:30 +00:00
Also the texture must be a power of two size to work
2014-12-03 10:39:11 +00:00
* @member PIXI.BaseTexture#mipmap
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 86
2014-12-03 10:39:11 +00:00
*/
/**
2014-11-15 20:01:46 +00:00
* @member PIXI.BaseTexture#_dirty
* @type {Array}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 95
2014-11-15 20:01:46 +00:00
*/
/**
2015-10-15 11:06:38 +00:00
* @description A BaseTexture can be set to skip the rendering phase in the WebGL Sprite Batch.
You may want to do this if you have a parent Sprite with no visible texture (i.e. uses the internal `__default` texture)
that has children that you do want to render, without causing a batch flush in the process.
* @member PIXI.BaseTexture#skipRender
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 115
2014-11-15 20:01:46 +00:00
*/
/**
* @member PIXI.BaseTexture#_powerOf2
* @type {Boolean}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 126
2015-07-22 14:31:30 +00:00
*/
/**
* @description Forces this BaseTexture to be set as loaded, with the given width and height.
Then calls BaseTexture.dirty.
Important for when you don't want to modify the source object by forcing in `complete` or dimension properties it may not have.
* @method PIXI.BaseTexture#forceLoaded
* @param {Number} width - - The new width to force the BaseTexture to be.
* @param {Number} height - - The new height to force the BaseTexture to be.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 137
2014-11-15 20:01:46 +00:00
*/
/**
* @description Destroys this base texture
* @method PIXI.BaseTexture#destroy
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 154
2014-11-15 20:01:46 +00:00
*/
/**
* @description Changes the source image of the texture
* @method PIXI.BaseTexture#updateSourceImage
* @param {String} newSrc - the path of the image
2016-07-08 14:46:26 +00:00
* @deprecated true
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 171
2014-11-15 20:01:46 +00:00
*/
/**
* @description Sets all glTextures to be dirty.
* @method PIXI.BaseTexture#dirty
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 183
2014-11-15 20:01:46 +00:00
*/
/**
* @description Removes the base texture from the GPU, useful for managing resources on the GPU.
Atexture is still 100% usable and will simply be reuploaded if there is a sprite on screen that is using it.
* @method PIXI.BaseTexture#unloadFromGPU
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 196
2014-11-15 20:01:46 +00:00
*/
/**
* @description Helper function that creates a base texture from the given canvas element.
* @method PIXI.BaseTexture.fromCanvas
* @param {Canvas} canvas - The canvas element source of the texture
* @param {Number} scaleMode - See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values
2016-02-08 17:01:36 +00:00
* @return {PIXI.BaseTexture}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/BaseTexture.js
2016-07-08 14:46:26 +00:00
* @sourceline 224
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.RenderTexture
* @description A RenderTexture is a special texture that allows any Pixi display object to be rendered to it.
__Hint__: All DisplayObjects (i.e. Sprites) that render to a RenderTexture should be preloaded otherwise black rectangles will be drawn instead.
A RenderTexture takes a snapshot of any Display Object given to its render method. The position and rotation of the given Display Objects is ignored. For example:
var renderTexture = new PIXI.RenderTexture(800, 600);
var sprite = PIXI.Sprite.fromImage("spinObj_01.png");
sprite.position.x = 800/2;
sprite.position.y = 600/2;
sprite.anchor.x = 0.5;
sprite.anchor.y = 0.5;
renderTexture.render(sprite);
The Sprite in this case will be rendered to a position of 0,0. To render this sprite at its actual position a DisplayObjectContainer should be used:
var doc = new PIXI.DisplayObjectContainer();
doc.addChild(sprite);
renderTexture.render(doc); // Renders to center of renderTexture
* @augments PIXI.Texture
* @param {Number} width - The width of the render texture
* @param {Number} height - The height of the render texture
* @param {(PIXI.CanvasRenderer|PIXI.WebGLRenderer)} renderer - The renderer used for this RenderTexture
* @param {Number} scaleMode - See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values
* @param {Number} resolution - The resolution of the texture being generated
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 5
*/
/**
* @description The with of the render texture
* @member PIXI.RenderTexture#width
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 37
*/
/**
* @description The height of the render texture
* @member PIXI.RenderTexture#height
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 45
*/
/**
* @description The Resolution of the texture.
* @member PIXI.RenderTexture#resolution
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 53
*/
/**
* @description The framing rectangle of the render texture
* @member PIXI.RenderTexture#frame
2015-03-23 23:46:30 +00:00
* @type {Rectangle}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 61
*/
/**
* @description This is the area of the BaseTexture image to actually copy to the Canvas / WebGL when rendering,
irrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)
* @member PIXI.RenderTexture#crop
2015-03-23 23:46:30 +00:00
* @type {Rectangle}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 69
*/
/**
* @description The base texture object that this texture uses
* @member PIXI.RenderTexture#baseTexture
* @type {PIXI.BaseTexture}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 78
*/
/**
* @description The renderer this RenderTexture uses. A RenderTexture can only belong to one renderer at the moment if its webGL.
* @member PIXI.RenderTexture#renderer
* @type {(PIXI.CanvasRenderer|PIXI.WebGLRenderer)}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 99
*/
/**
* @member PIXI.RenderTexture#valid
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2014-11-15 20:01:46 +00:00
* @sourceline 125
*/
/**
* @description Resizes the RenderTexture.
* @method PIXI.RenderTexture#resize
* @param {Number} width - The width to resize to.
* @param {Number} height - The height to resize to.
* @param {Boolean} updateBase - Should the baseTexture.width and height values be resized as well?
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2015-07-22 14:31:30 +00:00
* @sourceline 139
2014-11-15 20:01:46 +00:00
*/
/**
* @description Clears the RenderTexture.
* @method PIXI.RenderTexture#clear
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2015-07-22 14:31:30 +00:00
* @sourceline 175
2014-11-15 20:01:46 +00:00
*/
/**
* @description This function will draw the display object to the texture.
* @method PIXI.RenderTexture#renderWebGL
2016-07-01 15:57:13 +00:00
* @param {DisplayObject} displayObject - The display object to render this texture on
2015-03-23 23:46:30 +00:00
* @param {Matrix} [matrix] - Optional matrix to apply to the display object before rendering.
2014-11-15 20:01:46 +00:00
* @param {Boolean} [clear] - If true the texture will be cleared before the displayObject is drawn
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2015-07-22 14:31:30 +00:00
* @sourceline 195
2014-11-15 20:01:46 +00:00
*/
/**
* @description This function will draw the display object to the texture.
* @method PIXI.RenderTexture#renderCanvas
2016-07-01 15:57:13 +00:00
* @param {DisplayObject} displayObject - The display object to render this texture on
2015-03-23 23:46:30 +00:00
* @param {Matrix} [matrix] - Optional matrix to apply to the display object before rendering.
2014-11-15 20:01:46 +00:00
* @param {Boolean} [clear] - If true the texture will be cleared before the displayObject is drawn
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2015-07-22 14:31:30 +00:00
* @sourceline 250
2014-11-15 20:01:46 +00:00
*/
/**
* @description Will return a HTML Image of the texture
* @method PIXI.RenderTexture#getImage
* @return {Image}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2015-08-24 14:43:45 +00:00
* @sourceline 296
2014-11-15 20:01:46 +00:00
*/
/**
2015-07-22 14:31:30 +00:00
* @description Will return a base64 encoded string of this texture. It works by calling RenderTexture.getCanvas and then running toDataURL on that.
2014-11-15 20:01:46 +00:00
* @method PIXI.RenderTexture#getBase64
* @return {String} A base64 encoded string of the texture.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2015-08-24 14:43:45 +00:00
* @sourceline 309
2014-11-15 20:01:46 +00:00
*/
/**
* @description Creates a Canvas element, renders this RenderTexture to it and then returns it.
* @method PIXI.RenderTexture#getCanvas
* @return {HTMLCanvasElement} A Canvas element with the texture rendered on.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/RenderTexture.js
2015-08-24 14:43:45 +00:00
* @sourceline 320
2014-11-15 20:01:46 +00:00
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.Texture
* @description A texture stores the information that represents an image or part of an image. It cannot be added
to the display list directly. Instead use it as the texture for a PIXI.Sprite. If no frame is provided then the whole image is used.
* @param {PIXI.BaseTexture} baseTexture - The base texture source to create the texture from
2015-03-23 23:46:30 +00:00
* @param {Rectangle} frame - The rectangle frame of the texture to show
* @param {Rectangle} [crop] - The area of original texture
* @param {Rectangle} [trim] - Trimmed texture rectangle
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 14
2014-11-15 20:01:46 +00:00
*/
2015-03-23 23:46:30 +00:00
2014-11-15 20:01:46 +00:00
/**
* @description Does this Texture have any frame data assigned to it?
* @member PIXI.Texture#noFrame
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 28
2014-11-15 20:01:46 +00:00
*/
/**
* @description The base texture that this texture uses.
* @member PIXI.Texture#baseTexture
* @type {PIXI.BaseTexture}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 47
2014-11-15 20:01:46 +00:00
*/
/**
* @description The frame specifies the region of the base texture that this texture uses
* @member PIXI.Texture#frame
2015-03-23 23:46:30 +00:00
* @type {Rectangle}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 55
2014-11-15 20:01:46 +00:00
*/
/**
* @description The texture trim data.
* @member PIXI.Texture#trim
2015-03-23 23:46:30 +00:00
* @type {Rectangle}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 63
2014-11-15 20:01:46 +00:00
*/
/**
* @description This will let the renderer know if the texture is valid. If it's not then it cannot be rendered.
* @member PIXI.Texture#valid
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 71
2014-11-15 20:01:46 +00:00
*/
/**
2015-07-22 14:31:30 +00:00
* @description Is this a tiling texture? As used by the likes of a TilingSprite.
* @member PIXI.Texture#isTiling
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 79
2015-07-22 14:31:30 +00:00
*/
/**
2014-11-15 20:01:46 +00:00
* @description This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)
* @member PIXI.Texture#requiresUpdate
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 87
2015-07-22 14:31:30 +00:00
*/
/**
* @description This will let a renderer know that a tinted parent has updated its texture.
* @member PIXI.Texture#requiresReTint
* @type {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 95
2014-11-15 20:01:46 +00:00
*/
/**
* @description The WebGL UV data cache.
* @member PIXI.Texture#_uvs
* @type {Object}
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 103
2014-11-15 20:01:46 +00:00
*/
/**
* @description The width of the Texture in pixels.
* @member PIXI.Texture#width
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 112
2014-11-15 20:01:46 +00:00
*/
/**
* @description The height of the Texture in pixels.
* @member PIXI.Texture#height
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 120
2014-11-15 20:01:46 +00:00
*/
/**
* @description This is the area of the BaseTexture image to actually copy to the Canvas / WebGL when rendering,
irrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)
* @member PIXI.Texture#crop
2015-03-23 23:46:30 +00:00
* @type {Rectangle}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 128
2014-11-15 20:01:46 +00:00
*/
/**
* @description Called when the base texture is loaded
* @method PIXI.Texture#onBaseTextureLoaded
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 147
2014-11-15 20:01:46 +00:00
*/
/**
* @description Destroys this texture
* @method PIXI.Texture#destroy
* @param {Boolean} destroyBase - Whether to destroy the base texture as well
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 165
2014-11-15 20:01:46 +00:00
*/
/**
* @description Specifies the region of the baseTexture that this texture will use.
* @method PIXI.Texture#setFrame
2015-03-23 23:46:30 +00:00
* @param {Rectangle} frame - The frame of the texture to set it to
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 178
2014-11-15 20:01:46 +00:00
*/
/**
* @description Updates the internal WebGL UV cache.
* @method PIXI.Texture#_updateUvs
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 222
2014-11-15 20:01:46 +00:00
*/
/**
* @description Helper function that creates a new a Texture based on the given canvas element.
* @method PIXI.Texture.fromCanvas
* @param {Canvas} canvas - The canvas element source of the texture
* @param {Number} scaleMode - See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values
2016-02-08 17:01:36 +00:00
* @return {PIXI.Texture}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/textures/Texture.js
2016-07-08 14:46:26 +00:00
* @sourceline 249
2015-08-24 14:43:45 +00:00
*/
/**
* @fileoverview
* @author Richard Davey < rich@photonstorm.com>
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/CanvasPool.js
2015-08-24 14:43:45 +00:00
* @sourceline 1
*/
/**
* @class PIXI.CanvasPool
* @description The CanvasPool is a global static object that allows Pixi and Phaser to pool canvas DOM elements.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/CanvasPool.js
2015-08-24 14:43:45 +00:00
* @sourceline 7
*/
/**
* @description Creates a new Canvas DOM element, or pulls one from the pool if free.
* @method PIXI.CanvasPool.create
* @param {} parent - The parent of the canvas element.
* @param {Number} width - The width of the canvas element.
* @param {Number} height - The height of the canvas element.
* @return {HTMLCanvasElement} The canvas element.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/CanvasPool.js
2015-08-24 14:43:45 +00:00
* @sourceline 15
*/
/**
* @description Gets the first free canvas index from the pool.
* @method PIXI.CanvasPool.getFirst
* @return {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/CanvasPool.js
2015-08-24 14:43:45 +00:00
* @sourceline 58
*/
/**
* @description Removes the parent from a canvas element from the pool, freeing it up for re-use.
* @method PIXI.CanvasPool.remove
* @param {} parent - The parent of the canvas element.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/CanvasPool.js
2015-08-24 14:43:45 +00:00
* @sourceline 81
*/
/**
* @description Removes the parent from a canvas element from the pool, freeing it up for re-use.
* @method PIXI.CanvasPool.removeByCanvas
* @param {HTMLCanvasElement} canvas - The canvas element to remove
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/CanvasPool.js
2016-07-08 14:46:26 +00:00
* @sourceline 104
2015-08-24 14:43:45 +00:00
*/
/**
* @description Gets the total number of used canvas elements in the pool.
* @method PIXI.CanvasPool.getTotal
* @return {Number} The number of in-use (parented) canvas elements in the pool.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/CanvasPool.js
2016-07-08 14:46:26 +00:00
* @sourceline 127
2015-08-24 14:43:45 +00:00
*/
/**
* @description Gets the total number of free canvas elements in the pool.
* @method PIXI.CanvasPool.getFree
* @return {Number} The number of free (un-parented) canvas elements in the pool.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/CanvasPool.js
2016-07-08 14:46:26 +00:00
* @sourceline 151
2015-08-24 14:43:45 +00:00
*/
/**
* @description The pool into which the canvas dom elements are placed.
* @member PIXI.CanvasPool.pool
* @type {Array}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/CanvasPool.js
2016-07-08 14:46:26 +00:00
* @sourceline 177
2014-11-15 20:01:46 +00:00
*/
/**
2016-02-08 17:01:36 +00:00
* @class PIXI.EarCut
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EarCut.js
2016-02-08 17:01:36 +00:00
* @sourceline 17
*/
/**
2014-11-15 20:01:46 +00:00
* @fileoverview
* @author Chad Engler https://github.com/englercj @Rolnaaba
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
* @class PIXI.EventTarget
* @description Mixins event emitter functionality to a class
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 11
*/
/**
* @description Mixes in the properties of the EventTarget prototype onto another object
* @method PIXI.EventTarget#mixin
* @param {Object} object - The obj to mix into
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 34
*/
/**
* @description Return a list of assigned event listeners.
* @method PIXI.EventTarget#listeners
* @param {String} eventName - The events that should be listed.
* @return {Array} An array of listener functions
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 41
*/
/**
* @description Emit an event to all registered event listeners.
* @method PIXI.EventTarget#emit
* @param {String} eventName - The name of the event.
* @return {Boolean} Indication if we've emitted an event.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 54
*/
/**
* @description Register a new EventListener for the given event.
* @method PIXI.EventTarget#on
* @param {String} eventName - Name of the event.
* @param {Functon} callback - fn Callback function.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 107
*/
/**
* @description Add an EventListener that's only called once.
* @method PIXI.EventTarget#once
* @param {String} eventName - Name of the event.
* @param {Function} callback - Callback function.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 124
*/
/**
* @description Remove event listeners.
* @method PIXI.EventTarget#off
* @param {String} eventName - The event we want to remove.
* @param {Function} callback - The listener that we need to find.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 143
*/
/**
* @description Remove all listeners or only the listeners for the specified event.
* @method PIXI.EventTarget#removeAllListeners
* @param {String} eventName - The event you want to remove all listeners for.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 173
*/
/**
* @class PIXI.Event
* @description Creates an homogenous object for tracking events so users can know what to expect.
* @augments Object
* @param {Object} target - The target object that the event is called on
* @param {String} name - The string name of the event that was triggered
* @param {Object} data - Arbitrary event data to pass along
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 192
*/
/**
* @description Tracks the state of bubbling propagation. Do not
set this directly, instead use `event.stopPropagation()`
* @member PIXI.Event#stopped
* @type {Boolean}
* @readonly
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 206
*/
/**
* @description Tracks the state of sibling listener propagation. Do not
set this directly, instead use `event.stopImmediatePropagation()`
* @member PIXI.Event#stoppedImmediate
* @type {Boolean}
* @readonly
* @access private
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 217
*/
/**
* @description The original target the event triggered on.
* @member PIXI.Event#target
* @type {Object}
* @readonly
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 228
*/
/**
* @description The string name of the event that this represents.
* @member PIXI.Event#type
* @type {String}
* @readonly
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 237
*/
/**
* @description The data that was passed in with this event.
* @member PIXI.Event#data
* @type {Object}
* @readonly
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 246
*/
/**
* @description The timestamp when the event occurred.
* @member PIXI.Event#timeStamp
* @type {Number}
* @readonly
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 258
*/
/**
* @description Stops the propagation of events up the scene graph (prevents bubbling).
* @method PIXI.Event#stopPropagation
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 268
*/
/**
* @description Stops the propagation of events to sibling listeners (no longer calls any listeners).
* @method PIXI.Event#stopImmediatePropagation
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/EventTarget.js
2014-11-15 20:01:46 +00:00
* @sourceline 277
*/
/**
* @fileoverview
* @author Mat Groves http://matgroves.com/ @Doormat23
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/Utils.js
2014-11-15 20:01:46 +00:00
* @sourceline 1
*/
/**
2015-03-23 23:46:30 +00:00
* @class PIXI.PIXI
* @description Namespace-class for [pixi.js](http://www.pixijs.com/).
Contains assorted static properties and enumerations.
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/Pixi.js
2015-03-23 23:46:30 +00:00
* @sourceline 11
2014-11-15 20:01:46 +00:00
*/
/**
* @description Converts a hex color number to an [R, G, B] array
2015-03-23 23:46:30 +00:00
* @method PIXI.PIXI#hex2rgb
2014-11-15 20:01:46 +00:00
* @param {Number} hex -
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/Utils.js
2015-03-23 23:46:30 +00:00
* @sourceline 5
2014-11-15 20:01:46 +00:00
*/
/**
* @description Converts a color as an [R, G, B] array to a hex number
2015-03-23 23:46:30 +00:00
* @method PIXI.PIXI#rgb2hex
2014-11-15 20:01:46 +00:00
* @param {Array} rgb -
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/Utils.js
2015-03-23 23:46:30 +00:00
* @sourceline 15
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Checks whether the Canvas BlendModes are supported by the current browser for drawImage
* @method PIXI.PIXI#canUseNewCanvasBlendModes
2014-11-15 20:01:46 +00:00
* @return {Boolean} whether they are supported
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/Utils.js
2015-03-23 23:46:30 +00:00
* @sourceline 25
2014-11-15 20:01:46 +00:00
*/
/**
* @description Given a number, this function returns the closest number that is a power of two
this function is taken from Starling Framework as its pretty neat ;)
2015-03-23 23:46:30 +00:00
* @method PIXI.PIXI#getNextPowerOfTwo
2014-11-15 20:01:46 +00:00
* @param {Number} number -
* @return {Number} the closest number that is a power of two
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/Utils.js
2015-08-24 14:43:45 +00:00
* @sourceline 63
2014-11-15 20:01:46 +00:00
*/
/**
2015-01-06 06:57:25 +00:00
* @description checks if the given width and height make a power of two texture
2015-03-23 23:46:30 +00:00
* @method PIXI.PIXI#isPowerOfTwo
2015-01-06 06:57:25 +00:00
* @param {Number} width -
* @param {Number} height -
* @return {Boolean}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/utils/Utils.js
2015-08-24 14:43:45 +00:00
* @sourceline 83
2014-11-15 20:01:46 +00:00
*/
2015-03-23 23:46:30 +00:00
2015-10-15 11:06:38 +00:00
/**
* @description A reference to the Phaser Game instance that owns this Pixi renderer.
* @member PIXI.PIXI.game
* @type {PhaserGame}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/Pixi.js
2015-10-15 11:06:38 +00:00
* @sourceline 21
*/
2014-11-15 20:01:46 +00:00
/**
2015-03-23 23:46:30 +00:00
* @member PIXI.PIXI.WEBGL_RENDERER
* @type {Number}
* @access protected
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/Pixi.js
2015-10-15 11:06:38 +00:00
* @sourceline 28
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @member PIXI.PIXI.CANVAS_RENDERER
2014-11-15 20:01:46 +00:00
* @type {Number}
2015-03-23 23:46:30 +00:00
* @access protected
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/Pixi.js
2015-10-15 11:06:38 +00:00
* @sourceline 35
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description Version of pixi that is loaded.
* @member PIXI.PIXI.VERSION
2014-11-15 20:01:46 +00:00
* @type {String}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/Pixi.js
2015-10-15 11:06:38 +00:00
* @sourceline 42
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @member PIXI.PIXI.PI_2
2014-11-15 20:01:46 +00:00
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/Pixi.js
2015-10-15 11:06:38 +00:00
* @sourceline 71
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @member PIXI.PIXI.RAD_TO_DEG
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/Pixi.js
2015-10-15 11:06:38 +00:00
* @sourceline 77
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @member PIXI.PIXI.DEG_TO_RAD
* @type {Number}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/Pixi.js
2015-10-15 11:06:38 +00:00
* @sourceline 83
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @member PIXI.PIXI.RETINA_PREFIX
* @type {String}
* @access protected
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/Pixi.js
2015-10-15 11:06:38 +00:00
* @sourceline 89
2014-11-15 20:01:46 +00:00
*/
/**
2015-03-23 23:46:30 +00:00
* @description The default render options if none are supplied to
{{#crossLink "WebGLRenderer"}}{{/crossLink}} or {{#crossLink "CanvasRenderer"}}{{/crossLink}}.
* @member PIXI.PIXI.defaultRenderOptions
* @type {Object}
2016-08-26 00:18:47 +00:00
* @sourcefile /Users/rich/Documents/phaser/src/pixi/Pixi.js
2015-10-15 11:06:38 +00:00
* @sourceline 96
2014-11-15 20:01:46 +00:00
*/< / pre >
< / 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" >
2016-08-26 00:18:47 +00:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.4.0< / a >
on Fri Aug 26 2016 01:16:09 GMT+0100 (BST) using the < a href = "https://github.com/terryweiss/docstrap" > DocStrap template< / a > .
2014-11-15 20:01:46 +00:00
< / span >
< / footer >
< / div >
< br clear = "both" >
< / div >
< / div >
< script src = "scripts/sunlight.js" > < / script >
< script src = "scripts/sunlight.javascript.js" > < / script >
< script src = "scripts/sunlight-plugin.doclinks.js" > < / script >
< script src = "scripts/sunlight-plugin.linenumbers.js" > < / script >
< script src = "scripts/sunlight-plugin.menu.js" > < / script >
< script src = "scripts/jquery.min.js" > < / script >
< script src = "scripts/jquery.scrollTo.js" > < / script >
< script src = "scripts/jquery.localScroll.js" > < / script >
< script src = "scripts/bootstrap-dropdown.js" > < / script >
< script src = "scripts/toc.js" > < / script >
< script > Sunlight . highlightAll ( { lineNumbers : true , showMenu : true , enableDoclinks : true } ) ; < / script >
< script >
$( function () {
$( "#toc" ).toc( {
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 >
