The first DocGen output! The whole of Phaser and PIXI documentation as JSON files.

Author: photonstorm

docgen/output/PIXI.AbstractFilter.json

@@ -0,0 +1 @@
+{"class":{"name":"PIXI.AbstractFilter","extends":"","static":false,"constructor":true,"parameters":[{"name":"fragmentSrc","type":["array"],"help":"The fragment source in an array of strings.","optional":false,"default":null},{"name":"uniforms","type":["object"],"help":"An object containing the uniforms for this filter.","optional":false,"default":null}],"help":"This is the base class for creating a PIXI filter. Currently only webGL supports filters.\\nIf you want to make a custom filter this should be your base class."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"fragmentSrc","type":["array"],"help":"","inlineHelp":"","line":55,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"passes","type":["array"],"help":"An array of passes - some filters contain a few steps this array simply stores the steps in a liniear fashion.\\nFor example the blur filter has two passes blurX and blurY.","inlineHelp":"","line":22,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"shaders","type":["array"],"help":"","inlineHelp":"","line":29,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"uniforms","type":["object"],"help":"","inlineHelp":"","line":48,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}

docgen/output/PIXI.AjaxRequest.json

@@ -0,0 +1 @@
+{"class":{"name":"PIXI.AjaxRequest","extends":"","static":false,"constructor":true,"parameters":[],"help":"A wrapper for ajax requests to be handled cross browser"},"consts":[],"methods":{"public":[{"name":"bind","static":false,"returns":null,"help":"A polyfill for Function.prototype.bind","line":79,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"canUseNewCanvasBlendModes","static":false,"returns":{"types":["boolean"],"help":"whether they are supported"},"help":"Checks whether the Canvas BlendModes are supported by the current browser","line":174,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"cancelAnimationFrame","static":false,"returns":null,"help":"A polyfill for cancelAnimationFrame","line":25,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getNextPowerOfTwo","static":false,"returns":{"types":["number"],"help":"the closest number that is a power of two"},"help":"Given a number, this function returns the closest number that is a power of two\\nthis function is taken from Starling Framework as its pretty neat ;)","line":197,"public":true,"protected":false,"private":false,"parameters":[{"name":"number","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"hex2rgb","static":false,"returns":null,"help":"Converts a hex color number to an [R, G, B] array","line":60,"public":true,"protected":false,"private":false,"parameters":[{"name":"hex","type":["number"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"requestAnimationFrame","static":false,"returns":null,"help":"A polyfill for requestAnimationFrame\\nYou can actually use both requestAnimationFrame and requestAnimFrame,\\nyou will still benefit from the polyfill","line":19,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"rgb2hex","static":false,"returns":null,"help":"Converts a color as an [R, G, B] array to a hex number","line":70,"public":true,"protected":false,"private":false,"parameters":[{"name":"rgb","type":["array"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}}

docgen/output/PIXI.AlphaMaskFilter.json

@@ -0,0 +1 @@
+{"class":{"name":"PIXI.AlphaMaskFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The texture used for the displacement map * must be power of 2 texture at the moment","optional":false,"default":null}],"help":"The AlphaMaskFilter class uses the pixel values from the specified texture (called the displacement map) to perform a displacement of an object.\\nYou can use this filter to apply all manor of crazy warping effects\\nCurrently the r property of the texture is used to offset the x and the g property of the texture is used to offset the y."},"consts":[],"methods":{"public":[{"name":"onTextureLoaded","static":false,"returns":null,"help":"Sets the map dimensions uniforms when the texture becomes available.","line":76,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"map","type":["PIXI.Texture"],"help":"The texture used for the displacement map. Must be power of 2 sized texture.","inlineHelp":"","line":90,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}}

docgen/output/PIXI.AsciiFilter.json

@@ -0,0 +1 @@
+{"class":{"name":"PIXI.AsciiFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"An ASCII filter."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"size","type":["number"],"help":"The pixel size used by the filter.","inlineHelp":"","line":79,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}}

docgen/output/PIXI.AssetLoader.json

@@ -0,0 +1 @@
+{"class":{"name":"PIXI.AssetLoader","extends":"","static":false,"constructor":true,"parameters":[{"name":"assetURLs","type":["array string"],"help":"An array of image\/sprite sheet urls that you would like loaded","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"Whether requests should be treated as crossorigin","optional":false,"default":null}],"help":"A Class that loads a bunch of images \/ sprite sheet \/ bitmap font files. Once the\\nassets have been loaded they are added to the PIXI Texture cache and can be accessed\\neasily through PIXI.Texture.fromImage() and PIXI.Sprite.fromImage()\\nWhen all items have been loaded this class will dispatch a 'onLoaded' event\\nAs each individual item is loaded this class will dispatch a 'onProgress' event\\n\\nsupported. Supported image formats include 'jpeg', 'jpg', 'png', 'gif'. Supported\\nsprite sheet data formats only include 'JSON' at this time. Supported bitmap font\\ndata formats include 'xml' and 'fnt'."},"consts":[],"methods":{"public":[{"name":"_getDataType","static":false,"returns":null,"help":"Given a filename, returns its extension.","line":80,"public":true,"protected":false,"private":false,"parameters":[{"name":"str","type":["string"],"help":"the name of the asset","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"load","static":false,"returns":null,"help":"Starts loading the assets sequentially","line":112,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"onAssetLoaded","static":false,"returns":null,"help":"Invoked after each file is loaded","line":149,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"assetURLs","type":["array string"],"help":"The array of asset URLs that are going to be loaded","inlineHelp":"","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"crossorigin","type":["boolean"],"help":"Whether the requests should be treated as cross origin","inlineHelp":"","line":37,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"loadersByType","type":["object"],"help":"Maps file extension to loader types","inlineHelp":"","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}}

docgen/output/PIXI.AtlasLoader.json

@@ -0,0 +1 @@
+{"class":{"name":"PIXI.AtlasLoader","extends":"","static":false,"constructor":true,"parameters":[{"name":"url","type":["string"],"help":"The url of the JSON file","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"Whether requests should be treated as crossorigin","optional":false,"default":null}],"help":"The atlas file loader is used to load in Texture Atlas data and parse it. When loaded this class will dispatch a 'loaded' event. If loading fails this class will dispatch an 'error' event.\\n\\nTo generate the data you can use http:\/\/www.codeandweb.com\/texturepacker and publish in the 'JSON' format.\\n\\nIt is highly recommended to use texture atlases (also know as 'sprite sheets') as it allowed sprites to be batched and drawn together for highly increased rendering speed.\\nOnce the data has been loaded the frames are stored in the PIXI texture cache and can be accessed though PIXI.Texture.fromFrameId() and PIXI.Sprite.fromFrameId()"},"consts":[],"methods":{"public":[{"name":"load","static":false,"returns":null,"help":"Starts loading the JSON file","line":37,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"onAtlasLoaded","static":false,"returns":null,"help":"Invoked when the Atlas has fully loaded. Parses the JSON and builds the texture frames.","line":52,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onError","static":false,"returns":null,"help":"Invoked when an error occurs.","line":188,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onLoaded","static":false,"returns":null,"help":"Invoked when json file has loaded.","line":172,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[],"protected":[],"private":[]}}

docgen/output/PIXI.BaseTexture.json

@@ -0,0 +1 @@
+{"class":{"name":"PIXI.BaseTexture","extends":"","static":false,"constructor":true,"parameters":[{"name":"source","type":["string"],"help":"the source object (image or canvas)","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"help":"A texture stores the information that represents an image. All textures have a base texture."},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Destroys this base texture","line":156,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"dirty","static":false,"returns":null,"help":"Sets all glTextures to be dirty.","line":204,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"fromCanvas","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that creates a base texture from the given canvas element.","line":263,"public":true,"protected":false,"private":false,"parameters":[{"name":"canvas","type":["PIXI.Canvas"],"help":"The canvas element source of the texture","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"fromImage","static":true,"returns":{"types":[],"help":[]},"help":"Helper function that creates a base texture from the given image url.\\nIf the image is not in the base texture cache it will be created and loaded.","line":223,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageUrl","type":["string"],"help":"The image url of the texture","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updateSourceImage","static":false,"returns":null,"help":"Changes the source image of the texture","line":192,"public":true,"protected":false,"private":false,"parameters":[{"name":"newSrc","type":["string"],"help":"the path of the image","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"hasLoaded","type":["boolean"],"help":"[read-only] Set to true once the base texture has loaded","inlineHelp":"","line":62,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"height","type":["number"],"help":"[read-only] The height of the base texture set when the image has loaded","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"imageUrl","type":["string"],"help":"","inlineHelp":"","line":136,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"premultipliedAlpha","type":["boolean"],"help":"Controls if RGB channels should be pre-multiplied by Alpha  (WebGL only)","inlineHelp":"","line":81,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"resolution","type":["number"],"help":"The Resolution of the texture.","inlineHelp":"","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scaleMode","type":["PIXI.scaleModes"],"help":"The scale mode to apply when scaling this texture","inlineHelp":"","line":53,"default":"PIXI.scaleModes.LINEAR","public":true,"protected":false,"private":false,"readOnly":false},{"name":"source","type":["Image"],"help":"The image source that is used to create the texture.","inlineHelp":"","line":70,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"[read-only] The width of the base texture set when the image has loaded","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":true}],"protected":[],"private":[{"name":"_dirty","type":["array"],"help":"","inlineHelp":"","line":100,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_glTextures","type":["array"],"help":"","inlineHelp":"","line":90,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_powerOf2","type":["boolean"],"help":"","inlineHelp":"","line":143,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}

docgen/output/PIXI.BitmapFontLoader.json

@@ -0,0 +1 @@
+{"class":{"name":"PIXI.BitmapFontLoader","extends":"","static":false,"constructor":true,"parameters":[{"name":"url","type":["string"],"help":"The url of the sprite sheet JSON file","optional":false,"default":null},{"name":"crossorigin","type":["boolean"],"help":"Whether requests should be treated as crossorigin","optional":false,"default":null}],"help":"The xml loader is used to load in XML bitmap font data ('xml' or 'fnt')\\nTo generate the data you can use http:\/\/www.angelcode.com\/products\/bmfont\/\\nThis loader will also load the image file as the data.\\nWhen loaded this class will dispatch a 'loaded' event"},"consts":[],"methods":{"public":[{"name":"load","static":false,"returns":null,"help":"Loads the XML font data","line":62,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"onLoaded","static":false,"returns":null,"help":"Invoked when all files are loaded (xml\/fnt and texture)","line":158,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onXMLLoaded","static":false,"returns":null,"help":"Invoked when the XML file is loaded, parses the data.","line":78,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"baseUrl","type":["string"],"help":"[read-only] The base url of the bitmap font data","inlineHelp":"","line":42,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"crossorigin","type":["boolean"],"help":"Whether the requests should be treated as cross origin","inlineHelp":"","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"texture","type":["PIXI.Texture"],"help":"[read-only] The texture of the bitmap font","inlineHelp":"","line":50,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"url","type":["string"],"help":"The url of the bitmap font data","inlineHelp":"","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}}

docgen/output/PIXI.BitmapText.json

@@ -0,0 +1 @@
+{"class":{"name":"PIXI.BlurFilter","extends":"PIXI.AbstractFilter","static":false,"constructor":true,"parameters":[],"help":"The BlurFilter applies a Gaussian blur to an object.\\nThe strength of the blur can be set for x- and y-axis separately (always relative to the stage)."},"consts":[],"methods":{"public":[{"name":"syncUniforms","static":false,"returns":null,"help":"Syncs the uniforms between the class object and the shaders.","line":65,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.AbstractFilter"}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"blur","type":["number"],"help":"Sets the strength of both the blurX and blurY properties simultaneously","inlineHelp":"","line":31,"default":"2","public":true,"protected":false,"private":false,"readOnly":false},{"name":"blurX","type":["number"],"help":"Sets the strength of the blurX property","inlineHelp":"","line":47,"default":"2","public":true,"protected":false,"private":false,"readOnly":false},{"name":"blurY","type":["number"],"help":"Sets the strength of the blurY property","inlineHelp":"","line":63,"default":"2","public":true,"protected":false,"private":false,"readOnly":false},{"name":"dirty","type":["boolean"],"help":"","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"padding","type":["number"],"help":"","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}}