diff --git a/README.md b/README.md index 5b23b34..c4cb431 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,28 @@ Pixi Renderer ============= +#### *** IMPORTANT - DEV BRANCH API CHANGES *** #### + +A heads up for anyone using the dev branch of pixi.js as we have changed a couple of bits that you need to be aware of. Fortunatly there are only two changes and both are small. + +1: Creating a renderer no accepts an options parameter that you can add specific settings too: +``` +// an optional object that contains the settings for the renderer +var options = { + view:myCanvas, + resolution:1 +}; + +var renderer = new PIXI.WebGLRenderer(800, 600, options) +``` + +2: A ```PIXI.RenderTexture``` now accepts a ```PIXI.Matrix``` as its second param instead of a point. This gives you much more flexibility: + +``` myRenderTexture.render(myDisplayObject, myMatrix) ``` + +Check out the docs for more info! + + ![pixi.js logo](http://www.goodboydigital.com/pixijs/logo_small.png) [](http://www.pixijs.com/projects) diff --git a/README.md b/README.md index 5b23b34..c4cb431 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,28 @@ Pixi Renderer ============= +#### *** IMPORTANT - DEV BRANCH API CHANGES *** #### + +A heads up for anyone using the dev branch of pixi.js as we have changed a couple of bits that you need to be aware of. Fortunatly there are only two changes and both are small. + +1: Creating a renderer no accepts an options parameter that you can add specific settings too: +``` +// an optional object that contains the settings for the renderer +var options = { + view:myCanvas, + resolution:1 +}; + +var renderer = new PIXI.WebGLRenderer(800, 600, options) +``` + +2: A ```PIXI.RenderTexture``` now accepts a ```PIXI.Matrix``` as its second param instead of a point. This gives you much more flexibility: + +``` myRenderTexture.render(myDisplayObject, myMatrix) ``` + +Check out the docs for more info! + + ![pixi.js logo](http://www.goodboydigital.com/pixijs/logo_small.png) [](http://www.pixijs.com/projects) diff --git a/src/pixi/extras/Rope.js b/src/pixi/extras/Rope.js index f4b0852..29b6460 100644 --- a/src/pixi/extras/Rope.js +++ b/src/pixi/extras/Rope.js @@ -1,14 +1,16 @@ -/* @author Mat Groves http://matgroves.com/ @Doormat23 +/** + * @author Mat Groves http://matgroves.com/ @Doormat23 + * @copyright Mat Groves, Rovanion Luckey */ /** - * + * * @class Rope * @constructor * @extends Strip - * @param texture {Texture} The texture to use - * @param points {Array} - * + * @param {Texture} texture - The texture to use on the rope. + * @param {Array} points - An array of {PIXI.Point}. + * */ PIXI.Rope = function(texture, points) { @@ -19,7 +21,7 @@ this.uvs = new PIXI.Float32Array(points.length * 4); this.colors = new PIXI.Float32Array(points.length * 2); this.indices = new PIXI.Uint16Array(points.length * 2); - + this.refresh(); }; @@ -30,7 +32,7 @@ PIXI.Rope.prototype.constructor = PIXI.Rope; /* - * Refreshes + * Refreshes * * @method refresh */ @@ -159,7 +161,7 @@ PIXI.DisplayObjectContainer.prototype.updateTransform.call( this ); }; /* - * Sets the texture that the Rope will use + * Sets the texture that the Rope will use * * @method setTexture * @param texture {Texture} the texture that will be used