phaser/docs/Phaser.RenderTexture.html

3483 lines
63 KiB
HTML
Raw Normal View History

2013-10-25 15:54:40 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: RenderTexture</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
2014-11-15 20:01:46 +00:00
<link type="text/css" rel="stylesheet" href="styles/default.css">
2013-10-25 15:54:40 +00:00
<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
2013-10-25 15:54:40 +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>
2013-10-25 15:54:40 +00:00
<div class="navbar-inner">
2014-11-25 00:23:44 +00:00
<a class="brand" href="index.html">Phaser API</a>
2013-10-25 15:54:40 +00:00
<ul class="nav">
2014-11-25 00:23:44 +00:00
2013-10-25 15:54:40 +00:00
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
2014-04-10 22:13:43 +00:00
<li class="class-depth-0">
2013-10-25 15:54:40 +00:00
<a href="Phaser.html">Phaser</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-0">
<a href="PIXI.html">PIXI</a>
</li>
2013-10-25 15:54:40 +00:00
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Animation.html">Animation</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.AnimationManager.html">AnimationManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
2014-04-29 14:39:02 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.ArraySet.html">ArraySet</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayUtils.html">ArrayUtils</a>
</li>
2014-10-09 15:12:53 +00:00
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Button.html">Button</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Cache.html">Cache</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Camera.html">Camera</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Canvas.html">Canvas</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Circle.html">Circle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Color.html">Color</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Device.html">Device</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.DOM.html">DOM</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Easing.html">Easing</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Events.html">Events</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Filter.html">Filter</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-1">
<a href="Phaser.FlexGrid.html">FlexGrid</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexLayer.html">FlexLayer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Frame.html">Frame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.FrameData.html">FrameData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Game.html">Game</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.GamepadButton.html">GamepadButton</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Graphics.html">Graphics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Group.html">Group</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Input.html">Input</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Key.html">Key</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Line.html">Line</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Loader.html">Loader</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.LoaderParser.html">LoaderParser</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Math.html">Math</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Mouse.html">Mouse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Net.html">Net</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Particles.html">Particles</a>
</li>
2014-10-09 15:12:53 +00:00
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.html">Physics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Plugin.html">Plugin</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Point.html">Point</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Pointer.html">Pointer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Sound.html">Sound</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Sprite.html">Sprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Stage.html">Stage</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.State.html">State</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.StateManager.html">StateManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Text.html">Text</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tile.html">Tile</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tileset.html">Tileset</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Time.html">Time</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Timer.html">Timer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Touch.html">Touch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Tween.html">Tween</a>
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenData.html">TweenData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Utils.html">Utils</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.World.html">World</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="PIXI.AbstractFilter.html">AbstractFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AjaxRequest.html">AjaxRequest</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AlphaMaskFilter.html">AlphaMaskFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AsciiFilter.html">AsciiFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AssetLoader.html">AssetLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AtlasLoader.html">AtlasLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BaseTexture.html">BaseTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BitmapFontLoader.html">BitmapFontLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BlurFilter.html">BlurFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BlurXFilter.html">BlurXFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BlurYFilter.html">BlurYFilter</a>
</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>
<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.Circle.html">Circle</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ColorMatrixFilter.html">ColorMatrixFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ColorStepFilter.html">ColorStepFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ConvolutionFilter.html">ConvolutionFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CrossHatchFilter.html">CrossHatchFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplacementFilter.html">DisplacementFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObject.html">DisplayObject</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObjectContainer.html">DisplayObjectContainer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DotScreenFilter.html">DotScreenFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Ellipse.html">Ellipse</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Event.html">Event</a>
</li>
<li class="class-depth-1">
<a href="PIXI.EventTarget.html">EventTarget</a>
</li>
<li class="class-depth-1">
<a href="PIXI.FilterBlock.html">FilterBlock</a>
</li>
<li class="class-depth-1">
<a href="PIXI.FilterTexture.html">FilterTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.GraphicsData.html">GraphicsData</a>
</li>
<li class="class-depth-1">
<a href="PIXI.GrayFilter.html">GrayFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ImageLoader.html">ImageLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.InteractionData.html">InteractionData</a>
</li>
<li class="class-depth-1">
<a href="PIXI.InteractionManager.html">InteractionManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.InvertFilter.html">InvertFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.JsonLoader.html">JsonLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Matrix.html">Matrix</a>
</li>
<li class="class-depth-1">
<a href="PIXI.MovieClip.html">MovieClip</a>
</li>
<li class="class-depth-1">
<a href="PIXI.NoiseFilter.html">NoiseFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.NormalMapFilter.html">NormalMapFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixelateFilter.html">PixelateFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PIXI.html">PIXI</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiFastShader.html">PixiFastShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiShader.html">PixiShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Point.html">Point</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Polygon.html">Polygon</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PolyK.html">PolyK</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PrimitiveShader.html">PrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Rectangle.html">Rectangle</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RGBSplitFilter.html">RGBSplitFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RoundedRectangle.html">RoundedRectangle</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SepiaFilter.html">SepiaFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SmartBlurFilter.html">SmartBlurFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Spine.html">Spine</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpineLoader.html">SpineLoader</a>
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="PIXI.SpineTextureLoader.html">SpineTextureLoader</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="PIXI.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpriteSheetLoader.html">SpriteSheetLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Strip.html">Strip</a>
</li>
<li class="class-depth-1">
<a href="PIXI.StripShader.html">StripShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Text.html">Text</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Texture.html">Texture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TilingSprite.html">TilingSprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TiltShiftFilter.html">TiltShiftFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TiltShiftXFilter.html">TiltShiftXFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TiltShiftYFilter.html">TiltShiftYFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TwistFilter.html">TwistFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.VideoTexture.html">VideoTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLRenderer.html">WebGLRenderer</a>
</li>
2013-10-25 15:54:40 +00:00
</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>
<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>
<li class="class-depth-1"><a href="Phaser.InputManager.html">Input Manager</a></li>
<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>
<li class="class-depth-1"><a href="Phaser.Emitter.html">Emitter</a></li>
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="Phaser.Particle.html">Particle</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Text.html">Text</a></li>
<li class="class-depth-1"><a href="Phaser.Tween.html">Tween</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapText.html">BitmapText</a></li>
<li class="class-depth-1"><a href="Phaser.Tilemap.html">Tilemap</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapData.html">BitmapData</a></li>
<li class="class-depth-1"><a href="Phaser.RetroFont.html">RetroFont</a></li>
<li class="class-depth-1"><a href="Phaser.Button.html">Button</a></li>
<li class="class-depth-1"><a href="Phaser.Animation.html">Animation</a></li>
<li class="class-depth-1"><a href="Phaser.Graphics.html">Graphics</a></li>
<li class="class-depth-1"><a href="Phaser.RenderTexture.html">RenderTexture</a></li>
<li class="class-depth-1"><a href="Phaser.TileSprite.html">TileSprite</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Geometry<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Circle.html">Circle</a></li>
<li class="class-depth-1"><a href="Phaser.Rectangle.html">Rectangle</a></li>
<li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li>
<li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li>
<li class="class-depth-1"><a href="Phaser.Ellipse.html">Ellipse</a></li>
<li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</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">Physics<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Physics.Arcade.html">Arcade Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Arcade.Body.html">Body</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.P2.html">P2 Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Body.html">Body</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Spring.html">Spring</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.Ninja.html">Ninja Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Body.html">Body</a></li>
2014-11-15 20:01:46 +00:00
</ul>
</li>
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Input<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.InputHandler.html">Input Handler</a></li>
<li class="class-depth-1"><a href="Phaser.Pointer.html">Pointer</a></li>
<li class="class-depth-1"><a href="Phaser.Mouse.html">Mouse</a></li>
<li class="class-depth-1"><a href="Phaser.Keyboard.html">Keyboard</a></li>
<li class="class-depth-1"><a href="Phaser.Key.html">Key</a></li>
<li class="class-depth-1"><a href="Phaser.Gamepad.html">Gamepad</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Community<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li>
<li class="class-depth-1"><a href="http://examples.phaser.io">Phaser Examples</a></li>
<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>
<li class="class-depth-1"><a href="https://confirmsubscription.com/h/r/369DE48E3E86AF1E">Newsletter</a></li>
<li class="class-depth-1"><a href="https://twitter.com/photonstorm">Twitter</a></li>
<li class="class-depth-1"><a href="http://www.html5gamedevs.com/topic/4470-official-phaserio-irc-channel-phaserio-on-freenode/">IRC</a></li>
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="https://leanpub.com/u/photonstorm">Phaser Books</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="https://www.gittip.com/photonstorm/">GitTip</a></li>
</ul>
</li>
2014-11-15 20:01:46 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
2013-10-25 15:54:40 +00:00
<div class="span8">
<div id="main">
2014-11-25 00:23:44 +00:00
<!--<h1 class="page-title">Class: RenderTexture</h1>-->
2013-10-25 15:54:40 +00:00
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
RenderTexture
</h2>
</header>
<article>
<div class="container-overview">
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="RenderTexture"><span class="type-signature"></span>new RenderTexture<span class="signature">(game, key, <span class="optional">width</span>, <span class="optional">height</span>, <span class="optional">key</span>, <span class="optional">scaleMode</span>, <span class="optional">resolution</span>)</span><span class="type-signature"></span></h4>
2013-10-25 15:54:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
<div class="description">
2014-09-09 14:36:56 +00:00
<p>A RenderTexture is a special texture that allows any displayObject to be rendered to it. It allows you to take many complex objects and
render them down into a single quad (on WebGL) which can then be used to texture other display objects with. A way of generating textures at run-time.</p>
2013-10-25 15:54:40 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
2013-10-25 15:54:40 +00:00
<th>Default</th>
2013-10-25 15:54:40 +00:00
<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>
2013-10-25 15:54:40 +00:00
<td class="default">
</td>
2013-10-25 15:54:40 +00:00
<td class="description last"><p>Current game instance.</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>
2013-10-25 15:54:40 +00:00
<td class="default">
</td>
2013-10-25 15:54:40 +00:00
<td class="description last"><p>Internal Phaser reference key for the render texture.</p></td>
2013-10-25 15:54:40 +00:00
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
2013-10-25 15:54:40 +00:00
<td class="default">
100
</td>
2013-10-25 15:54:40 +00:00
<td class="description last"><p>The width of the render texture.</p></td>
2013-10-25 15:54:40 +00:00
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
2013-10-25 15:54:40 +00:00
<td class="default">
100
</td>
2013-10-25 15:54:40 +00:00
<td class="description last"><p>The height of the render texture.</p></td>
2013-10-25 15:54:40 +00:00
</tr>
2014-05-20 09:12:48 +00:00
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
''
</td>
<td class="description last"><p>The key of the RenderTexture in the Cache, if stored there.</p></td>
</tr>
<tr>
<td class="name"><code>scaleMode</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Phaser.scaleModes.DEFAULT
</td>
<td class="description last"><p>One of the Phaser.scaleModes consts.</p></td>
</tr>
2014-10-22 20:49:44 +00:00
<tr>
<td class="name"><code>resolution</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
1
</td>
<td class="description last"><p>The resolution of the texture being generated.</p></td>
</tr>
2013-10-25 15:54:40 +00:00
</tbody>
</table>
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="RenderTexture.js_.html">gameobjects/RenderTexture.js</a>, <a href="RenderTexture.js_.html#sunlight-1-line-22">line 22</a>
</dt>
2013-10-25 15:54:40 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
</dd>
</div>
2014-10-09 15:12:53 +00:00
<h3 class="subsection-title">Extends</h3>
<ul>
2014-11-15 20:01:46 +00:00
<li><a href="PIXI.RenderTexture.html">PIXI.RenderTexture</a></li>
2014-10-09 15:12:53 +00:00
</ul>
2013-10-25 15:54:40 +00:00
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="baseTexture"><span class="type-signature"></span>baseTexture<span class="type-signature"> :<a href="PIXI.BaseTexture.html">PIXI.BaseTexture</a></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The base texture object that this texture uses</p>
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.RenderTexture.html#baseTexture">PIXI.RenderTexture#baseTexture</a>
</li></dd>
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="RenderTexture.js.html#sunlight-1-line-78">line 78</a>
</dt>
2013-10-25 15:54:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="crop"><span class="type-signature"></span>crop<span class="type-signature"> :<a href="PIXI.Rectangle.html">PIXI.Rectangle</a></span></h4>
2013-10-25 15:54:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>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)</p>
</div>
2013-10-25 15:54:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.RenderTexture.html#crop">PIXI.RenderTexture#crop</a>
</li></dd>
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="RenderTexture.js.html#sunlight-1-line-69">line 69</a>
</dt>
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
</dl>
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
</dd>
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
id="frame"><span class="type-signature"></span>frame<span class="type-signature"> :<a href="PIXI.Rectangle.html">PIXI.Rectangle</a></span></h4>
</dt>
<dd>
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The framing rectangle of the render texture</p>
</div>
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
<dl class="details">
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.RenderTexture.html#frame">PIXI.RenderTexture#frame</a>
</li></dd>
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="RenderTexture.js.html#sunlight-1-line-61">line 61</a>
</dt>
2013-10-25 15:54:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="game"><span class="type-signature"></span>game<span class="type-signature"> :<a href="Phaser.Game.html">Phaser.Game</a></span></h4>
2013-10-25 15:54:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>A reference to the currently running game.</p>
</div>
2013-10-25 15:54:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="RenderTexture.js_.html">gameobjects/RenderTexture.js</a>, <a href="RenderTexture.js_.html#sunlight-1-line-31">line 31</a>
</dt>
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
</dl>
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
</dd>
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
id="height"><span class="type-signature"></span>height<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The height of the render texture</p>
</div>
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
<dl class="details">
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.RenderTexture.html#height">PIXI.RenderTexture#height</a>
</li></dd>
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="RenderTexture.js.html#sunlight-1-line-45">line 45</a>
</dt>
2013-10-25 15:54:40 +00:00
</dl>
</dd>
2014-10-22 20:49:44 +00:00
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="key"><span class="type-signature"></span>key<span class="type-signature"> :string</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The key of the RenderTexture in the Cache, if stored there.</p>
</div>
2014-10-22 20:49:44 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
2014-10-22 20:49:44 +00:00
2014-11-15 20:01:46 +00:00
2014-10-22 20:49:44 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="RenderTexture.js_.html">gameobjects/RenderTexture.js</a>, <a href="RenderTexture.js_.html#sunlight-1-line-36">line 36</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="matrix"><span class="type-signature"></span>matrix<span class="type-signature"> :<a href="PIXI.Matrix.html">PIXI.Matrix</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The matrix that is applied when display objects are rendered to this RenderTexture.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="RenderTexture.js_.html">gameobjects/RenderTexture.js</a>, <a href="RenderTexture.js_.html#sunlight-1-line-46">line 46</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="noFrame"><span class="type-signature"></span>noFrame<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Does this Texture have any frame data assigned to it?</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Texture.html#noFrame">PIXI.Texture#noFrame</a>
</li></dd>
<dt class="tag-source">Source -
<a href="Texture.js.html">pixi/textures/Texture.js</a>, <a href="Texture.js.html#sunlight-1-line-24">line 24</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="renderer"><span class="type-signature"></span>renderer<span class="type-signature"> :<a href="PIXI.CanvasRenderer.html">PIXI.CanvasRenderer</a>|<a href="PIXI.WebGLRenderer.html">PIXI.WebGLRenderer</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The renderer this RenderTexture uses. A RenderTexture can only belong to one renderer at the moment if its webGL.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="PIXI.CanvasRenderer.html">PIXI.CanvasRenderer</a></span>
|
<span class="param-type"><a href="PIXI.WebGLRenderer.html">PIXI.WebGLRenderer</a></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.RenderTexture.html#renderer">PIXI.RenderTexture#renderer</a>
</li></dd>
<dt class="tag-source">Source -
<a href="RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="RenderTexture.js.html#sunlight-1-line-99">line 99</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="requiresUpdate"><span class="type-signature"></span>requiresUpdate<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Texture.html#requiresUpdate">PIXI.Texture#requiresUpdate</a>
</li></dd>
<dt class="tag-source">Source -
<a href="Texture.js.html">pixi/textures/Texture.js</a>, <a href="Texture.js.html#sunlight-1-line-75">line 75</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="resolution"><span class="type-signature"></span>resolution<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The Resolution of the texture.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.RenderTexture.html#resolution">PIXI.RenderTexture#resolution</a>
</li></dd>
<dt class="tag-source">Source -
<a href="RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="RenderTexture.js.html#sunlight-1-line-53">line 53</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="trim"><span class="type-signature"></span>trim<span class="type-signature"> :<a href="PIXI.Rectangle.html">PIXI.Rectangle</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The texture trim data.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Texture.html#trim">PIXI.Texture#trim</a>
</li></dd>
<dt class="tag-source">Source -
<a href="Texture.js.html">pixi/textures/Texture.js</a>, <a href="Texture.js.html#sunlight-1-line-59">line 59</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="type"><span class="type-signature"></span>type<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>Base Phaser object type.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="RenderTexture.js_.html">gameobjects/RenderTexture.js</a>, <a href="RenderTexture.js_.html#sunlight-1-line-41">line 41</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="valid"><span class="type-signature"></span>valid<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.RenderTexture.html#valid">PIXI.RenderTexture#valid</a>
</li></dd>
<dt class="tag-source">Source -
<a href="RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="RenderTexture.js.html#sunlight-1-line-125">line 125</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="width"><span class="type-signature"></span>width<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The with of the render texture</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.RenderTexture.html#width">PIXI.RenderTexture#width</a>
</li></dd>
<dt class="tag-source">Source -
<a href="RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="RenderTexture.js.html#sunlight-1-line-37">line 37</a>
</dt>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<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 RenderTexture.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.RenderTexture.html#clear">PIXI.RenderTexture#clear</a>
</li></dd>
<dt class="tag-source">Source -
<a href="RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="RenderTexture.js.html#sunlight-1-line-171">line 171</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="destroy"><span class="type-signature"></span>destroy<span class="signature">(destroyBase)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Destroys this texture</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>destroyBase</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last"><p>Whether to destroy the base texture as well</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Texture.html#destroy">PIXI.Texture#destroy</a>
</li></dd>
<dt class="tag-source">Source -
<a href="Texture.js.html">pixi/textures/Texture.js</a>, <a href="Texture.js.html#sunlight-1-line-149">line 149</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getBase64"><span class="type-signature"></span>getBase64<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
</dt>
<dd>
<div class="description">
<p>Will return a a base64 encoded string of this texture. It works by calling RenderTexture.getCanvas and then running toDataURL on that.</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">String</span>
-
</div>
<div class="returns-desc param-desc">
<p>A base64 encoded string of the texture.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.RenderTexture.html#getBase64">PIXI.RenderTexture#getBase64</a>
</li></dd>
<dt class="tag-source">Source -
<a href="RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="RenderTexture.js.html#sunlight-1-line-291">line 291</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getCanvas"><span class="type-signature"></span>getCanvas<span class="signature">()</span><span class="type-signature"> &rarr; {HTMLCanvasElement}</span></h4>
</dt>
<dd>
<div class="description">
<p>Creates a Canvas element, renders this RenderTexture to it and then returns it.</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">HTMLCanvasElement</span>
-
</div>
<div class="returns-desc param-desc">
<p>A Canvas element with the texture rendered on.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.RenderTexture.html#getCanvas">PIXI.RenderTexture#getCanvas</a>
</li></dd>
<dt class="tag-source">Source -
<a href="RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="RenderTexture.js.html#sunlight-1-line-302">line 302</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getImage"><span class="type-signature"></span>getImage<span class="signature">()</span><span class="type-signature"> &rarr; {Image}</span></h4>
</dt>
<dd>
<div class="description">
<p>Will return a HTML Image of the texture</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">Image</span>
-
</div>
<div class="returns-desc param-desc">
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.RenderTexture.html#getImage">PIXI.RenderTexture#getImage</a>
</li></dd>
<dt class="tag-source">Source -
<a href="RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="RenderTexture.js.html#sunlight-1-line-278">line 278</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="render"><span class="type-signature"></span>render<span class="signature">(displayObject, position, clear)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This function will draw the display object to the texture.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2014-11-15 20:01:46 +00:00
<td class="name"><code>displayObject</code></td>
<td class="type">
2014-11-15 20:01:46 +00:00
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|
<span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span>
|
<span class="param-type"><a href="Phaser.Text.html">Phaser.Text</a></span>
|
<span class="param-type"><a href="Phaser.BitmapText.html">Phaser.BitmapText</a></span>
|
<span class="param-type"><a href="Phaser.Group.html">Phaser.Group</a></span>
</td>
<td class="description last"><p>The display object to render to this texture.</p></td>
</tr>
<tr>
<td class="name"><code>position</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
</td>
<td class="description last"><p>A Point object containing the position to render the display object at.</p></td>
</tr>
<tr>
<td class="name"><code>clear</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
2014-11-15 20:01:46 +00:00
<td class="description last"><p>If true the texture will be cleared before the display object is drawn.</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="RenderTexture.js_.html">gameobjects/RenderTexture.js</a>, <a href="RenderTexture.js_.html#sunlight-1-line-82">line 82</a>
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
2014-11-15 20:01:46 +00:00
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="renderXY"><span class="type-signature"></span>renderXY<span class="signature">(displayObject, x, y, clear)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>This function will draw the display object to the texture.</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>displayObject</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|
<span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span>
|
<span class="param-type"><a href="Phaser.Text.html">Phaser.Text</a></span>
|
<span class="param-type"><a href="Phaser.BitmapText.html">Phaser.BitmapText</a></span>
|
<span class="param-type"><a href="Phaser.Group.html">Phaser.Group</a></span>
</td>
<td class="description last"><p>The display object to render to this texture.</p></td>
</tr>
<tr>
2014-11-15 20:01:46 +00:00
<td class="name"><code>x</code></td>
<td class="type">
2014-11-15 20:01:46 +00:00
<span class="param-type">number</span>
</td>
2014-11-15 20:01:46 +00:00
<td class="description last"><p>The x position to render the object at.</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 position to render the object at.</p></td>
</tr>
<tr>
<td class="name"><code>clear</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>If true the texture will be cleared before the display object is drawn.</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="RenderTexture.js_.html">gameobjects/RenderTexture.js</a>, <a href="RenderTexture.js_.html#sunlight-1-line-57">line 57</a>
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="resize"><span class="type-signature"></span>resize<span class="signature">(width, height, updateBase)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2014-11-15 20:01:46 +00:00
<p>Resizes the RenderTexture.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2014-11-15 20:01:46 +00:00
<td class="name"><code>width</code></td>
2014-10-22 20:49:44 +00:00
<td class="type">
2014-11-15 20:01:46 +00:00
<span class="param-type">Number</span>
2014-10-22 20:49:44 +00:00
</td>
2014-11-15 20:01:46 +00:00
<td class="description last"><p>The width to resize to.</p></td>
2014-10-22 20:49:44 +00:00
</tr>
<tr>
2014-11-15 20:01:46 +00:00
<td class="name"><code>height</code></td>
<td class="type">
2014-11-15 20:01:46 +00:00
<span class="param-type">Number</span>
</td>
2014-11-15 20:01:46 +00:00
<td class="description last"><p>The height to resize to.</p></td>
</tr>
<tr>
2014-11-15 20:01:46 +00:00
<td class="name"><code>updateBase</code></td>
<td class="type">
2014-11-15 20:01:46 +00:00
<span class="param-type">Boolean</span>
</td>
2014-11-15 20:01:46 +00:00
<td class="description last"><p>Should the baseTexture.width and height values be resized as well?</p></td>
2014-10-22 20:49:44 +00:00
</tr>
2014-11-15 20:01:46 +00:00
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.RenderTexture.html#resize">PIXI.RenderTexture#resize</a>
</li></dd>
<dt class="tag-source">Source -
<a href="RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="RenderTexture.js.html#sunlight-1-line-137">line 137</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="setFrame"><span class="type-signature"></span>setFrame<span class="signature">(frame)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Specifies the region of the baseTexture that this texture will use.</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>
2014-10-22 20:49:44 +00:00
<tr>
2014-11-15 20:01:46 +00:00
<td class="name"><code>frame</code></td>
2014-10-22 20:49:44 +00:00
<td class="type">
2014-11-15 20:01:46 +00:00
<span class="param-type"><a href="PIXI.Rectangle.html">PIXI.Rectangle</a></span>
2014-10-22 20:49:44 +00:00
</td>
2014-11-15 20:01:46 +00:00
<td class="description last"><p>The frame of the texture to set it to</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Texture.html#setFrame">PIXI.Texture#setFrame</a>
</li></dd>
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Texture.js.html">pixi/textures/Texture.js</a>, <a href="Texture.js.html#sunlight-1-line-162">line 162</a>
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
</dl>
2013-10-25 15:54:40 +00:00
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
2013-10-25 15:54:40 +00:00
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
2014-12-03 10:39:11 +00:00
on Wed Dec 03 2014 10:30:59 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
2013-10-25 15:54:40 +00:00
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
2013-10-25 15:54:40 +00:00
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>