<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Phaser Class: BitmapData</title> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css"> <link type="text/css" rel="stylesheet" href="styles/site.cerulean.css"> </head> <body> <div class="container-fluid"> <div class="navbar navbar-fixed-top navbar-inverse"> <div class="navbar-inner"> <a class="brand" href="index.html">Phaser</a> <ul class="nav"> <li class="dropdown"> <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a> <ul class="dropdown-menu "> <li> <a href="Phaser.html">Phaser</a> </li> </ul> </li> <li class="dropdown"> <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a> <ul class="dropdown-menu "> <li> <a href="Phaser.Animation.html">Animation</a> </li> <li> <a href="Phaser.AnimationManager.html">AnimationManager</a> </li> <li> <a href="Phaser.AnimationParser.html">AnimationParser</a> </li> <li> <a href="Phaser.BitmapData.html">BitmapData</a> </li> <li> <a href="Phaser.BitmapFont.html">BitmapFont</a> </li> <li> <a href="Phaser.BitmapText.html">BitmapText</a> </li> <li> <a href="Phaser.Button.html">Button</a> </li> <li> <a href="Phaser.Cache.html">Cache</a> </li> <li> <a href="Phaser.Camera.html">Camera</a> </li> <li> <a href="Phaser.Canvas.html">Canvas</a> </li> <li> <a href="Phaser.Circle.html">Circle</a> </li> <li> <a href="Phaser.Color.html">Color</a> </li> <li> <a href="Phaser.Device.html">Device</a> </li> <li> <a href="Phaser.Easing.html">Easing</a> </li> <li> <a href="Phaser.Easing.Back.html">Back</a> </li> <li> <a href="Phaser.Easing.Bounce.html">Bounce</a> </li> <li> <a href="Phaser.Easing.Circular.html">Circular</a> </li> <li> <a href="Phaser.Easing.Cubic.html">Cubic</a> </li> <li> <a href="Phaser.Easing.Elastic.html">Elastic</a> </li> <li> <a href="Phaser.Easing.Exponential.html">Exponential</a> </li> <li> <a href="Phaser.Easing.Linear.html">Linear</a> </li> <li> <a href="Phaser.Easing.Quadratic.html">Quadratic</a> </li> <li> <a href="Phaser.Easing.Quartic.html">Quartic</a> </li> <li> <a href="Phaser.Easing.Quintic.html">Quintic</a> </li> <li> <a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a> </li> <li> <a href="Phaser.Ellipse.html">Ellipse</a> </li> <li> <a href="Phaser.Events.html">Events</a> </li> <li> <a href="Phaser.Filter.html">Filter</a> </li> <li> <a href="Phaser.Frame.html">Frame</a> </li> <li> <a href="Phaser.FrameData.html">FrameData</a> </li> <li> <a href="Phaser.Game.html">Game</a> </li> <li> <a href="Phaser.GameObjectCreator.html">GameObjectCreator</a> </li> <li> <a href="Phaser.GameObjectFactory.html">GameObjectFactory</a> </li> <li> <a href="Phaser.Gamepad.html">Gamepad</a> </li> <li> <a href="Phaser.GamepadButton.html">GamepadButton</a> </li> <li> <a href="Phaser.Graphics.html">Graphics</a> </li> <li> <a href="Phaser.Group.html">Group</a> </li> <li> <a href="Phaser.Image.html">Image</a> </li> <li> <a href="Phaser.Input.html">Input</a> </li> <li> <a href="Phaser.InputHandler.html">InputHandler</a> </li> <li> <a href="Phaser.Key.html">Key</a> </li> <li> <a href="Phaser.Keyboard.html">Keyboard</a> </li> <li> <a href="Phaser.Line.html">Line</a> </li> <li> <a href="Phaser.LinkedList.html">LinkedList</a> </li> <li> <a href="Phaser.Loader.html">Loader</a> </li> <li> <a href="Phaser.LoaderParser.html">LoaderParser</a> </li> <li> <a href="Phaser.Math.html">Math</a> </li> <li> <a href="Phaser.Mouse.html">Mouse</a> </li> <li> <a href="Phaser.MSPointer.html">MSPointer</a> </li> <li> <a href="Phaser.Net.html">Net</a> </li> <li> <a href="Phaser.Particles.html">Particles</a> </li> <li> <a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a> </li> <li> <a href="Phaser.Physics.html">Physics</a> </li> <li> <a href="Phaser.Physics.Arcade.html">Arcade</a> </li> <li> <a href="Phaser.Physics.Body.html">Body</a> </li> <li> <a href="Phaser.Physics.CollisionGroup.html">CollisionGroup</a> </li> <li> <a href="Phaser.Physics.ContactMaterial.html">ContactMaterial</a> </li> <li> <a href="Phaser.Physics.InversePointProxy.html">InversePointProxy</a> </li> <li> <a href="Phaser.Physics.Material.html">Material</a> </li> <li> <a href="Phaser.Physics.PointProxy.html">PointProxy</a> </li> <li> <a href="Phaser.Physics.Spring.html">Spring</a> </li> <li> <a href="Phaser.Physics.World.html">World</a> </li> <li> <a href="Phaser.Plugin.html">Plugin</a> </li> <li> <a href="Phaser.PluginManager.html">PluginManager</a> </li> <li> <a href="Phaser.Point.html">Point</a> </li> <li> <a href="Phaser.Pointer.html">Pointer</a> </li> <li> <a href="Phaser.Polygon.html">Polygon</a> </li> <li> <a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a> </li> <li> <a href="Phaser.Rectangle.html">Rectangle</a> </li> <li> <a href="Phaser.RenderTexture.html">RenderTexture</a> </li> <li> <a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a> </li> <li> <a href="Phaser.Signal.html">Signal</a> </li> <li> <a href="Phaser.SinglePad.html">SinglePad</a> </li> <li> <a href="Phaser.Sound.html">Sound</a> </li> <li> <a href="Phaser.SoundManager.html">SoundManager</a> </li> <li> <a href="Phaser.Sprite.html">Sprite</a> </li> <li> <a href="Phaser.SpriteBatch.html">SpriteBatch</a> </li> <li> <a href="Phaser.Stage.html">Stage</a> </li> <li> <a href="Phaser.StageScaleMode.html">StageScaleMode</a> </li> <li> <a href="Phaser.State.html">State</a> </li> <li> <a href="Phaser.StateManager.html">StateManager</a> </li> <li> <a href="Phaser.Text.html">Text</a> </li> <li> <a href="Phaser.Tile.html">Tile</a> </li> <li> <a href="Phaser.Tilemap.html">Tilemap</a> </li> <li> <a href="Phaser.TilemapLayer.html">TilemapLayer</a> </li> <li> <a href="Phaser.TilemapParser.html">TilemapParser</a> </li> <li> <a href="Phaser.Tileset.html">Tileset</a> </li> <li> <a href="Phaser.TileSprite.html">TileSprite</a> </li> <li> <a href="Phaser.Time.html">Time</a> </li> <li> <a href="Phaser.Timer.html">Timer</a> </li> <li> <a href="Phaser.TimerEvent.html">TimerEvent</a> </li> <li> <a href="Phaser.Touch.html">Touch</a> </li> <li> <a href="Phaser.Tween.html">Tween</a> </li> <li> <a href="Phaser.TweenManager.html">TweenManager</a> </li> <li> <a href="Phaser.Utils.html">Utils</a> </li> <li> <a href="Phaser.Utils.Debug.html">Debug</a> </li> <li> <a href="Phaser.World.html">World</a> </li> <li> <a href="SignalBinding.html">SignalBinding</a> </li> </ul> </li> <li class="dropdown"> <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a> <ul class="dropdown-menu "> <li> <a href="global.html#canUseNewCanvasBlendModes">canUseNewCanvasBlendModes</a> </li> <li> <a href="global.html#getBounds">getBounds</a> </li> <li> <a href="global.html#getNextPowerOfTwo">getNextPowerOfTwo</a> </li> <li> <a href="global.html#hex2rgb">hex2rgb</a> </li> <li> <a href="global.html#hitTest">hitTest</a> </li> <li> <a href="global.html#rgb2hex">rgb2hex</a> </li> </ul> </li> </ul> </div> </div> <div class="row-fluid"> <div class="span8"> <div id="main"> <h1 class="page-title">Class: BitmapData</h1> <section> <header> <h2> <span class="ancestors"><a href="Phaser.html">Phaser</a>.</span> BitmapData </h2> <div class="class-description"><p>A BitmapData object contains a Canvas element to which you can draw anything you like via normal Canvas context operations. A single BitmapData can be used as the texture one or many Images/Sprites. So if you need to dynamically create a Sprite texture then they are a good choice.</p></div> </header> <article> <div class="container-overview"> <dt> <h4 class="name" id="BitmapData"><span class="type-signature"></span>new BitmapData<span class="signature">(game, key, <span class="optional">width</span>, <span class="optional">height</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Creates a new BitmapData object.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>game</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>A reference to the currently running game.</p></td> </tr> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>Internal Phaser reference key for the render texture.</p></td> </tr> <tr> <td class="name"><code>width</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 100 </td> <td class="description last"><p>The width of the BitmapData in pixels.</p></td> </tr> <tr> <td class="name"><code>height</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 100 </td> <td class="description last"><p>The height of the BitmapData in pixels.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-21">line 21</a> </li></ul></dd> </dl> </dd> </div> <h3 class="subsection-title">Members</h3> <dl> <dt> <h4 class="name" id="baseTexture"><span class="type-signature"></span>baseTexture<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>baseTexture</code></td> <td class="type"> <span class="param-type">PIXI.BaseTexture</span> </td> <td class="description last"><p>The PIXI.BaseTexture.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-84">line 84</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="canvas"><span class="type-signature"></span>canvas<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>canvas</code></td> <td class="type"> <span class="param-type">HTMLCanvasElement</span> </td> <td class="description last"><p>The canvas to which this BitmapData draws.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-50">line 50</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="context"><span class="type-signature"></span>context<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>context</code></td> <td class="type"> <span class="param-type">CanvasRenderingContext2D</span> </td> <td class="description last"><p>The 2d context of the canvas.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-56">line 56</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="ctx"><span class="type-signature"></span>ctx<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>ctx</code></td> <td class="type"> <span class="param-type">CanvasRenderingContext2D</span> </td> <td class="description last"><p>A reference to BitmapData.context.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-61">line 61</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="game"><span class="type-signature"></span>game<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>game</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span> </td> <td class="description last"><p>A reference to the currently running game.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-29">line 29</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="height"><span class="type-signature"></span>height<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>height</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The height of the BitmapData in pixels.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-44">line 44</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="imageData"><span class="type-signature"></span>imageData<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>imageData</code></td> <td class="type"> <span class="param-type">array</span> </td> <td class="description last"><p>The canvas image data.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-66">line 66</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="key"><span class="type-signature"></span>key<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The key of the BitmapData in the Cache, if stored there.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-34">line 34</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="pixels"><span class="type-signature"></span>pixels<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>pixels</code></td> <td class="type"> <span class="param-type">UInt8Clamped</span> </td> <td class="description last"><p>A reference to the context imageData buffer.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-73">line 73</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="texture"><span class="type-signature"></span>texture<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>texture</code></td> <td class="type"> <span class="param-type">PIXI.Texture</span> </td> <td class="description last"><p>The PIXI.Texture.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-90">line 90</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="textureFrame"><span class="type-signature"></span>textureFrame<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>textureFrame</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Frame.html">Phaser.Frame</a></span> </td> <td class="description last"><p>The Frame this BitmapData uses for rendering.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-96">line 96</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The const type of this object.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-102">line 102</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="width"><span class="type-signature"></span>width<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>width</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The width of the BitmapData in pixels.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-39">line 39</a> </li></ul></dd> </dl> </dd> </dl> <h3 class="subsection-title">Methods</h3> <dl> <dt> <h4 class="name" id="add"><span class="type-signature"></span>add<span class="signature">(object)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Updates the given objects so that they use this BitmapData as their texture. This will replace any texture they will currently have set.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>object</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span> | <span class="param-type"><a href="Array.html">Array</a>.<<a href="Phaser.Sprite.html">Phaser.Sprite</a>></span> | <span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span> | <span class="param-type"><a href="Array.html">Array</a>.<<a href="Phaser.Image.html">Phaser.Image</a>></span> </td> <td class="description last"><p>Either a single Sprite/Image or an Array of Sprites/Images.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-110">line 110</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="alphaMask"><span class="type-signature"></span>alphaMask<span class="signature">(source, mask)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Draws the given image onto this BitmapData using an image as an alpha mask.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>source</code></td> <td class="type"> <span class="param-type">HTMLImage</span> | <span class="param-type">string</span> </td> <td class="description last"><p>The Image to draw. If you give a key it will try and find the Image in the Game.Cache.</p></td> </tr> <tr> <td class="name"><code>mask</code></td> <td class="type"> <span class="param-type">HTMLImage</span> | <span class="param-type">string</span> </td> <td class="description last"><p>The Image to use as the alpha mask. If you give a key it will try and find the Image in the Game.Cache.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-327">line 327</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="clear"><span class="type-signature"></span>clear<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Clears the BitmapData.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-135">line 135</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="copyPixels"><span class="type-signature"></span>copyPixels<span class="signature">(source, area, destX, destY)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Copies the pixels from the source image to this BitmapData based on the given area and destination.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>source</code></td> <td class="type"> <span class="param-type">HTMLImage</span> | <span class="param-type">string</span> </td> <td class="description last"><p>The Image to draw. If you give a key it will try and find the Image in the Game.Cache.</p></td> </tr> <tr> <td class="name"><code>area</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span> </td> <td class="description last"><p>The Rectangle region to copy from the source image.</p></td> </tr> <tr> <td class="name"><code>destX</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The destination x coordinate to copy the image to.</p></td> </tr> <tr> <td class="name"><code>destY</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The destination y coordinate to copy the image to.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-286">line 286</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="draw"><span class="type-signature"></span>draw<span class="signature">(source, destX, destY)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Draws the given image to this BitmapData at the coordinates specified. If you need to only draw a part of the image use BitmapData.copyPixels instead.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>source</code></td> <td class="type"> <span class="param-type">HTMLImage</span> | <span class="param-type">string</span> </td> <td class="description last"><p>The Image to draw. If you give a key it will try and find the Image in the Game.Cache.</p></td> </tr> <tr> <td class="name"><code>destX</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The destination x coordinate to draw the image to.</p></td> </tr> <tr> <td class="name"><code>destY</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The destination y coordinate to draw the image to.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-307">line 307</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="getPixel"><span class="type-signature"></span>getPixel<span class="signature">(x, y)</span><span class="type-signature"> → {number}</span></h4> </dt> <dd> <div class="description"> <p>Get the color of a specific pixel.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The X coordinate of the pixel to get.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The Y coordinate of the pixel to get.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-241">line 241</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>A native color value integer (format: 0xRRGGBB)</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">number</span> </dd> </dl> </dd> <dt> <h4 class="name" id="getPixel32"><span class="type-signature"></span>getPixel32<span class="signature">(x, y)</span><span class="type-signature"> → {number}</span></h4> </dt> <dd> <div class="description"> <p>Get the color of a specific pixel including its alpha value.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The X coordinate of the pixel to get.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The Y coordinate of the pixel to get.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-257">line 257</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>A native color value integer (format: 0xAARRGGBB)</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">number</span> </dd> </dl> </dd> <dt> <h4 class="name" id="getPixels"><span class="type-signature"></span>getPixels<span class="signature">(rect)</span><span class="type-signature"> → {array}</span></h4> </dt> <dd> <div class="description"> <p>Gets all the pixels from the region specified by the given Rectangle object.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>rect</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span> </td> <td class="description last"><p>The Rectangle region to get.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-272">line 272</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>CanvasPixelArray.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">array</span> </dd> </dl> </dd> <dt> <h4 class="name" id="refreshBuffer"><span class="type-signature"></span>refreshBuffer<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-169">line 169</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="render"><span class="type-signature"></span>render<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>If the game is running in WebGL this will push the texture up to the GPU if it's dirty. This is called automatically if the BitmapData is being used by a Sprite, otherwise you need to remember to call it in your render function.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-357">line 357</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="resize"><span class="type-signature"></span>resize<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Resizes the BitmapData.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-147">line 147</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="setPixel"><span class="type-signature"></span>setPixel<span class="signature">(x, y, red, green, blue)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Sets the color of the given pixel to the specified red, green and blue values.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The X coordinate of the pixel to be set.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The Y coordinate of the pixel to be set.</p></td> </tr> <tr> <td class="name"><code>red</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The red color value (between 0 and 255)</p></td> </tr> <tr> <td class="name"><code>green</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The green color value (between 0 and 255)</p></td> </tr> <tr> <td class="name"><code>blue</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The blue color value (between 0 and 255)</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-218">line 218</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="setPixel32"><span class="type-signature"></span>setPixel32<span class="signature">(x, y, red, green, blue, alpha)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Sets the color of the given pixel to the specified red, green, blue and alpha values.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The X coordinate of the pixel to be set.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The Y coordinate of the pixel to be set.</p></td> </tr> <tr> <td class="name"><code>red</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The red color value, between 0 and 0xFF (255).</p></td> </tr> <tr> <td class="name"><code>green</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The green color value, between 0 and 0xFF (255).</p></td> </tr> <tr> <td class="name"><code>blue</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The blue color value, between 0 and 0xFF (255).</p></td> </tr> <tr> <td class="name"><code>alpha</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The alpha color value, between 0 and 0xFF (255).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="BitmapData.js.html">gameobjects/BitmapData.js</a>, <a href="BitmapData.js.html#sunlight-1-line-182">line 182</a> </li></ul></dd> </dl> </dd> </dl> </article> </section> </div> <div class="clearfix"></div> <footer> <span class="copyright"> Phaser Copyright © 2012-2014 Photon Storm Ltd. </span> <br /> <span class="jsdoc-message"> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a> on Mon Feb 24 2014 12:11:35 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. </span> </footer> </div> <div class="span3"> <div id="toc"></div> </div> <br clear="both"> </div> </div> <script src="scripts/sunlight.js"></script> <script src="scripts/sunlight.javascript.js"></script> <script src="scripts/sunlight-plugin.doclinks.js"></script> <script src="scripts/sunlight-plugin.linenumbers.js"></script> <script src="scripts/sunlight-plugin.menu.js"></script> <script src="scripts/jquery.min.js"></script> <script src="scripts/jquery.scrollTo.js"></script> <script src="scripts/jquery.localScroll.js"></script> <script src="scripts/bootstrap-dropdown.js"></script> <script src="scripts/toc.js"></script> <script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script> <script> $( function () { $( "#toc" ).toc( { 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>