phaser-ce
Version:
Phaser CE (Community Edition) is a fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers.
1 lines • 2.82 MB
JSON
{"classes":[{"name":"PIXI.DisplayObject","description":"The base class for all objects that are rendered. Contains properties for position, scaling,\nrotation, masks and cache handling.\n\nThis is an abstract class and should not be used on its own, rather it should be extended.\n\nIt is used internally by the likes of PIXI.Sprite.","constructor":{"name":"DisplayObject","description":"The base class for all objects that are rendered. Contains properties for position, scaling,\nrotation, masks and cache handling.\n\nThis is an abstract class and should not be used on its own, rather it should be extended.\n\nIt is used internally by the likes of PIXI.Sprite.","parameters":[]},"functions":[],"members":[{"name":"position","access":"","virtual":false,"description":"The coordinates, in pixels, of this DisplayObject, relative to its parent container.\n\nThe value of this property does not reflect any positioning happening further up the display list.\nTo obtain that value please see the `worldPosition` property.","type":{"names":["PIXIPoint"]},"default":""},{"name":"scale","access":"","virtual":false,"description":"The scale of this DisplayObject. A scale of 1:1 represents the DisplayObject\nat its default size. A value of 0.5 would scale this DisplayObject by half, and so on.\n\nThe value of this property does not reflect any scaling happening further up the display list.\nTo obtain that value please see the `worldScale` property.","type":{"names":["PIXIPoint"]},"default":""},{"name":"pivot","access":"","virtual":false,"description":"The pivot point of this DisplayObject that it rotates around. The values are expressed\nin pixel values.","type":{"names":["PIXIPoint"]},"default":""},{"name":"rotation","access":"","virtual":false,"description":"The rotation of this DisplayObject. The value is given, and expressed, in radians, and is based on\na right-handed orientation.\n\nThe value of this property does not reflect any rotation happening further up the display list.\nTo obtain that value please see the `worldRotation` property.","type":{"names":["Number"]},"default":""},{"name":"alpha","access":"","virtual":false,"description":"The alpha value of this DisplayObject. A value of 1 is fully opaque. A value of 0 is transparent.\nPlease note that an object with an alpha value of 0 is skipped during the render pass.\n\nThe value of this property does not reflect any alpha values set further up the display list.\nTo obtain that value please see the `worldAlpha` property.","type":{"names":["Number"]},"default":""},{"name":"visible","access":"","virtual":false,"description":"The visibility of this DisplayObject. A value of `false` makes the object invisible.\nA value of `true` makes it visible. Please note that an object with a visible value of\n`false` is skipped during the render pass. Equally a DisplayObject with visible false will\nnot render any of its children.\n\nThe value of this property does not reflect any visible values set further up the display list.\nTo obtain that value please see the `worldVisible` property.","type":{"names":["Boolean"]},"default":""},{"name":"hitArea","access":"","virtual":false,"description":"This is the defined area that will pick up mouse / touch events. It is null by default.\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","type":{"names":["Rectangle","Circle","Ellipse","Polygon"]},"default":""},{"name":"renderable","access":"","virtual":false,"description":"Should this DisplayObject be rendered by the renderer? An object with a renderable value of\n`false` is skipped during the render pass.","type":{"names":["Boolean"]},"default":""},{"name":"parent","access":"","virtual":false,"description":"The parent DisplayObjectContainer that this DisplayObject is a child of.\nAll DisplayObjects must belong to a parent in order to be rendered.\nThe root parent is the Stage object. This property is set automatically when the\nDisplayObject is added to, or removed from, a DisplayObjectContainer.","type":{"names":["PIXIDisplayObjectContainer"]},"default":""},{"name":"worldAlpha","access":"","virtual":false,"description":"The multiplied alpha value of this DisplayObject. A value of 1 is fully opaque. A value of 0 is transparent.\nThis value is the calculated total, based on the alpha values of all parents of this DisplayObjects \nin the display list.\n\nTo obtain, and set, the local alpha value, see the `alpha` property.\n\nNote: This property is only updated at the end of the `updateTransform` call, once per render. Until \nthat happens this property will contain values based on the previous frame. Be mindful of this if\naccessing this property outside of the normal game flow, i.e. from an asynchronous event callback.","type":{"names":["Number"]},"default":""},{"name":"worldTransform","access":"","virtual":false,"description":"The current transform of this DisplayObject.\n\nThis property contains the calculated total, based on the transforms of all parents of this \nDisplayObject in the display list.\n\nNote: This property is only updated at the end of the `updateTransform` call, once per render. Until \nthat happens this property will contain values based on the previous frame. Be mindful of this if\naccessing this property outside of the normal game flow, i.e. from an asynchronous event callback.","type":{"names":["PIXIMatrix"]},"default":""},{"name":"worldPosition","access":"","virtual":false,"description":"The coordinates, in pixels, of this DisplayObject within the world.\n\nThis property contains the calculated total, based on the positions of all parents of this \nDisplayObject in the display list.\n\nNote: This property is only updated at the end of the `updateTransform` call, once per render. Until \nthat happens this property will contain values based on the previous frame. Be mindful of this if\naccessing this property outside of the normal game flow, i.e. from an asynchronous event callback.","type":{"names":["PIXIPoint"]},"default":""},{"name":"worldScale","access":"","virtual":false,"description":"The global scale of this DisplayObject.\n\nThis property contains the calculated total, based on the scales of all parents of this \nDisplayObject in the display list.\n\nNote: This property is only updated at the end of the `updateTransform` call, once per render. Until \nthat happens this property will contain values based on the previous frame. Be mindful of this if\naccessing this property outside of the normal game flow, i.e. from an asynchronous event callback.","type":{"names":["PIXIPoint"]},"default":""},{"name":"worldRotation","access":"","virtual":false,"description":"The rotation, in radians, of this DisplayObject.\n\nThis property contains the calculated total, based on the rotations of all parents of this \nDisplayObject in the display list.\n\nNote: This property is only updated at the end of the `updateTransform` call, once per render. Until \nthat happens this property will contain values based on the previous frame. Be mindful of this if\naccessing this property outside of the normal game flow, i.e. from an asynchronous event callback.","type":{"names":["Number"]},"default":""},{"name":"filterArea","access":"","virtual":false,"description":"The rectangular area used by filters when rendering a shader for this DisplayObject.","type":{"names":["Rectangle"]},"default":""},{"name":"_sr","access":"private","virtual":false,"description":"","type":{"names":["Number"]},"default":""},{"name":"_cr","access":"private","virtual":false,"description":"","type":{"names":["Number"]},"default":""},{"name":"_bounds","access":"private","virtual":false,"description":"","type":{"names":["PIXIRectangle"]},"default":""},{"name":"_currentBounds","access":"private","virtual":false,"description":"","type":{"names":["PIXIRectangle"]},"default":""},{"name":"_mask","access":"private","virtual":false,"description":"","type":{"names":["PIXIRectangle"]},"default":""},{"name":"_cacheAsBitmap","access":"private","virtual":false,"description":"","type":{"names":["Boolean"]},"default":""},{"name":"_cacheIsDirty","access":"private","virtual":false,"description":"","type":{"names":["Boolean"]},"default":""},{"name":"x","access":"","virtual":false,"description":"The horizontal position of the DisplayObject, in pixels, relative to its parent.\nIf you need the world position of the DisplayObject, use `DisplayObject.worldPosition` instead.","type":{"names":["Number"]},"default":""},{"name":"y","access":"","virtual":false,"description":"The vertical position of the DisplayObject, in pixels, relative to its parent.\nIf you need the world position of the DisplayObject, use `DisplayObject.worldPosition` instead.","type":{"names":["Number"]},"default":""},{"name":"worldVisible","access":"","virtual":false,"description":"Indicates if this DisplayObject is visible, based on it, and all of its parents, `visible` property values.","type":{"names":["Boolean"]},"default":""},{"name":"mask","access":"","virtual":false,"description":"Sets a mask for this DisplayObject. A mask is an instance of a Graphics object.\nWhen applied it limits the visible area of this DisplayObject to the shape of the mask.\nUnder a Canvas renderer it uses shape clipping. Under a WebGL renderer it uses a Stencil Buffer.\nTo remove a mask, set this property to `null`.","type":{"names":["PIXIGraphics"]},"default":""},{"name":"filters","access":"","virtual":false,"description":"Sets the filters for this DisplayObject. This is a WebGL only feature, and is ignored by the Canvas\nRenderer. A filter is a shader applied to this DisplayObject. You can modify the placement of the filter\nusing `DisplayObject.filterArea`.\n\nTo remove filters, set this property to `null`.\n\nNote: You cannot have a filter set, and a MULTIPLY Blend Mode active, at the same time. Setting a \nfilter will reset this DisplayObjects blend mode to NORMAL.","type":{"names":["Array"]},"default":""},{"name":"cacheAsBitmap","access":"","virtual":false,"description":"Sets if this DisplayObject should be cached as a bitmap.\n\nWhen invoked it will take a snapshot of the DisplayObject, as it is at that moment, and store it \nin a RenderTexture. This is then used whenever this DisplayObject is rendered. It can provide a\nperformance benefit for complex, but static, DisplayObjects. I.e. those with lots of children.\n\nCached Bitmaps do not track their parents. If you update a property of this DisplayObject, it will not\nre-generate the cached bitmap automatically. To do that you need to call `DisplayObject.updateCache`.\n\nTo remove a cached bitmap, set this property to `null`.","type":{"names":["Boolean"]},"default":""}]},{"name":"PIXI.DisplayObjectContainer","description":"A DisplayObjectContainer represents a collection of display objects.\nIt is the base class of all display objects that act as a container for other objects.","constructor":{"name":"DisplayObjectContainer","description":"A DisplayObjectContainer represents a collection of display objects.\nIt is the base class of all display objects that act as a container for other objects.","parameters":[]},"functions":[{"name":"addChild","description":"Adds a child to the container.","parameters":[{"name":"child","type":"PIXI.DisplayObject","description":"The DisplayObject to add to the container","default":"","optional":"","nullable":""}],"returns":{"type":"PIXI.DisplayObject","description":"The child that was added."}},{"name":"addChildAt","description":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","parameters":[{"name":"child","type":"PIXI.DisplayObject","description":"The child to add","default":"","optional":"","nullable":""},{"name":"index","type":"Number","description":"The index to place the child in","default":"","optional":"","nullable":""}],"returns":{"type":"PIXI.DisplayObject","description":"The child that was added."}},{"name":"swapChildren","description":"Swaps the position of 2 Display Objects within this container.","parameters":[{"name":"child","type":"PIXI.DisplayObject","description":"-","default":"","optional":"","nullable":""},{"name":"child2","type":"PIXI.DisplayObject","description":"-","default":"","optional":"","nullable":""}]},{"name":"getChildIndex","description":"Returns the index position of a child DisplayObject instance","parameters":[{"name":"child","type":"PIXI.DisplayObject","description":"The DisplayObject instance to identify","default":"","optional":"","nullable":""}],"returns":{"type":"Number","description":"The index position of the child display object to identify"}},{"name":"setChildIndex","description":"Changes the position of an existing child in the display object container","parameters":[{"name":"child","type":"PIXI.DisplayObject","description":"The child DisplayObject instance for which you want to change the index number","default":"","optional":"","nullable":""},{"name":"index","type":"Number","description":"The resulting index number for the child display object","default":"","optional":"","nullable":""}]},{"name":"getChildAt","description":"Returns the child at the specified index","parameters":[{"name":"index","type":"Number","description":"The index to get the child from","default":"","optional":"","nullable":""}],"returns":{"type":"PIXI.DisplayObject","description":"The child at the given index, if any."}},{"name":"removeChild","description":"Removes a child from the container.","parameters":[{"name":"child","type":"PIXI.DisplayObject","description":"The DisplayObject to remove","default":"","optional":"","nullable":""}],"returns":{"type":"PIXI.DisplayObject","description":"The child that was removed."}},{"name":"removeChildAt","description":"Removes a child from the specified index position.","parameters":[{"name":"index","type":"Number","description":"The index to get the child from","default":"","optional":"","nullable":""}],"returns":{"type":"PIXI.DisplayObject","description":"The child that was removed."}},{"name":"removeChildren","description":"Removes all children from this container that are within the begin and end indexes.","parameters":[{"name":"beginIndex","type":"Number","description":"The beginning position. Default value is 0.","default":"","optional":"","nullable":""},{"name":"endIndex","type":"Number","description":"The ending position. Default value is size of the container.","default":"","optional":"","nullable":""}]},{"name":"getBounds","description":"Retrieves the global bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.","parameters":[{"name":"targetCoordinateSpace","type":["PIXIDisplayObject","PIXIMatrix"],"description":"Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.","default":"","optional":true,"nullable":""}],"returns":{"type":"Rectangle","description":"The rectangular bounding area"}},{"name":"getLocalBounds","description":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle without any transformations. The calculation takes all visible children into consideration.","parameters":[],"returns":{"type":"Rectangle","description":"The rectangular bounding area"}},{"name":"contains","description":"Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.","parameters":[{"name":"child","type":"PIXI.DisplayObject","description":"-","default":"","optional":"","nullable":""}],"returns":{"type":"Boolean","description":""}},{"name":"_renderWebGL","description":"Renders the object using the WebGL renderer","parameters":[{"name":"renderSession","type":"RenderSession","description":"-","default":"","optional":"","nullable":""}]},{"name":"_renderCanvas","description":"Renders the object using the Canvas renderer","parameters":[{"name":"renderSession","type":"RenderSession","description":"-","default":"","optional":"","nullable":""}]}],"members":[{"name":"children","access":"","virtual":false,"description":"[read-only] The array of children of this container.","type":{"names":["Array.<DisplayObject>"]},"default":""},{"name":"ignoreChildInput","access":"","virtual":false,"description":"If `ignoreChildInput` is `false` it will allow this objects _children_ to be considered as valid for Input events.\n\nIf this property is `true` then the children will _not_ be considered as valid for Input events.\n\nNote that this property isn't recursive: only immediate children are influenced, it doesn't scan further down.","type":{"names":["Boolean"]},"default":""},{"name":"width","access":"","virtual":false,"description":"The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","type":{"names":["Number"]},"default":""},{"name":"height","access":"","virtual":false,"description":"The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","type":{"names":["Number"]},"default":""},{"name":"position","access":"","virtual":false,"description":"The coordinates, in pixels, of this DisplayObject, relative to its parent container.\n\nThe value of this property does not reflect any positioning happening further up the display list.\nTo obtain that value please see the `worldPosition` property.","type":{"names":["PIXIPoint"]},"default":""},{"name":"scale","access":"","virtual":false,"description":"The scale of this DisplayObject. A scale of 1:1 represents the DisplayObject\nat its default size. A value of 0.5 would scale this DisplayObject by half, and so on.\n\nThe value of this property does not reflect any scaling happening further up the display list.\nTo obtain that value please see the `worldScale` property.","type":{"names":["PIXIPoint"]},"default":""},{"name":"pivot","access":"","virtual":false,"description":"The pivot point of this DisplayObject that it rotates around. The values are expressed\nin pixel values.","type":{"names":["PIXIPoint"]},"default":""},{"name":"rotation","access":"","virtual":false,"description":"The rotation of this DisplayObject. The value is given, and expressed, in radians, and is based on\na right-handed orientation.\n\nThe value of this property does not reflect any rotation happening further up the display list.\nTo obtain that value please see the `worldRotation` property.","type":{"names":["Number"]},"default":""},{"name":"alpha","access":"","virtual":false,"description":"The alpha value of this DisplayObject. A value of 1 is fully opaque. A value of 0 is transparent.\nPlease note that an object with an alpha value of 0 is skipped during the render pass.\n\nThe value of this property does not reflect any alpha values set further up the display list.\nTo obtain that value please see the `worldAlpha` property.","type":{"names":["Number"]},"default":""},{"name":"visible","access":"","virtual":false,"description":"The visibility of this DisplayObject. A value of `false` makes the object invisible.\nA value of `true` makes it visible. Please note that an object with a visible value of\n`false` is skipped during the render pass. Equally a DisplayObject with visible false will\nnot render any of its children.\n\nThe value of this property does not reflect any visible values set further up the display list.\nTo obtain that value please see the `worldVisible` property.","type":{"names":["Boolean"]},"default":""},{"name":"hitArea","access":"","virtual":false,"description":"This is the defined area that will pick up mouse / touch events. It is null by default.\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","type":{"names":["Rectangle","Circle","Ellipse","Polygon"]},"default":""},{"name":"renderable","access":"","virtual":false,"description":"Should this DisplayObject be rendered by the renderer? An object with a renderable value of\n`false` is skipped during the render pass.","type":{"names":["Boolean"]},"default":""},{"name":"parent","access":"","virtual":false,"description":"The parent DisplayObjectContainer that this DisplayObject is a child of.\nAll DisplayObjects must belong to a parent in order to be rendered.\nThe root parent is the Stage object. This property is set automatically when the\nDisplayObject is added to, or removed from, a DisplayObjectContainer.","type":{"names":["PIXIDisplayObjectContainer"]},"default":""},{"name":"worldAlpha","access":"","virtual":false,"description":"The multiplied alpha value of this DisplayObject. A value of 1 is fully opaque. A value of 0 is transparent.\nThis value is the calculated total, based on the alpha values of all parents of this DisplayObjects \nin the display list.\n\nTo obtain, and set, the local alpha value, see the `alpha` property.\n\nNote: This property is only updated at the end of the `updateTransform` call, once per render. Until \nthat happens this property will contain values based on the previous frame. Be mindful of this if\naccessing this property outside of the normal game flow, i.e. from an asynchronous event callback.","type":{"names":["Number"]},"default":""},{"name":"worldTransform","access":"","virtual":false,"description":"The current transform of this DisplayObject.\n\nThis property contains the calculated total, based on the transforms of all parents of this \nDisplayObject in the display list.\n\nNote: This property is only updated at the end of the `updateTransform` call, once per render. Until \nthat happens this property will contain values based on the previous frame. Be mindful of this if\naccessing this property outside of the normal game flow, i.e. from an asynchronous event callback.","type":{"names":["PIXIMatrix"]},"default":""},{"name":"worldPosition","access":"","virtual":false,"description":"The coordinates, in pixels, of this DisplayObject within the world.\n\nThis property contains the calculated total, based on the positions of all parents of this \nDisplayObject in the display list.\n\nNote: This property is only updated at the end of the `updateTransform` call, once per render. Until \nthat happens this property will contain values based on the previous frame. Be mindful of this if\naccessing this property outside of the normal game flow, i.e. from an asynchronous event callback.","type":{"names":["PIXIPoint"]},"default":""},{"name":"worldScale","access":"","virtual":false,"description":"The global scale of this DisplayObject.\n\nThis property contains the calculated total, based on the scales of all parents of this \nDisplayObject in the display list.\n\nNote: This property is only updated at the end of the `updateTransform` call, once per render. Until \nthat happens this property will contain values based on the previous frame. Be mindful of this if\naccessing this property outside of the normal game flow, i.e. from an asynchronous event callback.","type":{"names":["PIXIPoint"]},"default":""},{"name":"worldRotation","access":"","virtual":false,"description":"The rotation, in radians, of this DisplayObject.\n\nThis property contains the calculated total, based on the rotations of all parents of this \nDisplayObject in the display list.\n\nNote: This property is only updated at the end of the `updateTransform` call, once per render. Until \nthat happens this property will contain values based on the previous frame. Be mindful of this if\naccessing this property outside of the normal game flow, i.e. from an asynchronous event callback.","type":{"names":["Number"]},"default":""},{"name":"filterArea","access":"","virtual":false,"description":"The rectangular area used by filters when rendering a shader for this DisplayObject.","type":{"names":["Rectangle"]},"default":""},{"name":"_sr","access":"private","virtual":false,"description":"","type":{"names":["Number"]},"default":""},{"name":"_cr","access":"private","virtual":false,"description":"","type":{"names":["Number"]},"default":""},{"name":"_bounds","access":"private","virtual":false,"description":"","type":{"names":["PIXIRectangle"]},"default":""},{"name":"_currentBounds","access":"private","virtual":false,"description":"","type":{"names":["PIXIRectangle"]},"default":""},{"name":"_mask","access":"private","virtual":false,"description":"","type":{"names":["PIXIRectangle"]},"default":""},{"name":"_cacheAsBitmap","access":"private","virtual":false,"description":"","type":{"names":["Boolean"]},"default":""},{"name":"_cacheIsDirty","access":"private","virtual":false,"description":"","type":{"names":["Boolean"]},"default":""},{"name":"x","access":"","virtual":false,"description":"The horizontal position of the DisplayObject, in pixels, relative to its parent.\nIf you need the world position of the DisplayObject, use `DisplayObject.worldPosition` instead.","type":{"names":["Number"]},"default":""},{"name":"y","access":"","virtual":false,"description":"The vertical position of the DisplayObject, in pixels, relative to its parent.\nIf you need the world position of the DisplayObject, use `DisplayObject.worldPosition` instead.","type":{"names":["Number"]},"default":""},{"name":"worldVisible","access":"","virtual":false,"description":"Indicates if this DisplayObject is visible, based on it, and all of its parents, `visible` property values.","type":{"names":["Boolean"]},"default":""},{"name":"mask","access":"","virtual":false,"description":"Sets a mask for this DisplayObject. A mask is an instance of a Graphics object.\nWhen applied it limits the visible area of this DisplayObject to the shape of the mask.\nUnder a Canvas renderer it uses shape clipping. Under a WebGL renderer it uses a Stencil Buffer.\nTo remove a mask, set this property to `null`.","type":{"names":["PIXIGraphics"]},"default":""},{"name":"filters","access":"","virtual":false,"description":"Sets the filters for this DisplayObject. This is a WebGL only feature, and is ignored by the Canvas\nRenderer. A filter is a shader applied to this DisplayObject. You can modify the placement of the filter\nusing `DisplayObject.filterArea`.\n\nTo remove filters, set this property to `null`.\n\nNote: You cannot have a filter set, and a MULTIPLY Blend Mode active, at the same time. Setting a \nfilter will reset this DisplayObjects blend mode to NORMAL.","type":{"names":["Array"]},"default":""},{"name":"cacheAsBitmap","access":"","virtual":false,"description":"Sets if this DisplayObject should be cached as a bitmap.\n\nWhen invoked it will take a snapshot of the DisplayObject, as it is at that moment, and store it \nin a RenderTexture. This is then used whenever this DisplayObject is rendered. It can provide a\nperformance benefit for complex, but static, DisplayObjects. I.e. those with lots of children.\n\nCached Bitmaps do not track their parents. If you update a property of this DisplayObject, it will not\nre-generate the cached bitmap automatically. To do that you need to call `DisplayObject.updateCache`.\n\nTo remove a cached bitmap, set this property to `null`.","type":{"names":["Boolean"]},"default":""}]},{"name":"PIXI.Sprite","description":"The Sprite object is the base for all textured objects that are rendered to the screen","constructor":{"name":"Sprite","description":"The Sprite object is the base for all textured objects that are rendered to the screen","parameters":[{"name":"texture","type":"PIXI.Texture","description":"The texture for this sprite","default":"","optional":"","nullable":""}]},"functions":[{"name":"setTexture","description":"Sets the texture of the sprite. Be warned that this doesn't remove or destroy the previous\ntexture this Sprite was using.","parameters":[{"name":"texture","type":"PIXI.Texture","description":"The PIXI texture that is displayed by the sprite","default":"","optional":"","nullable":""},{"name":"destroy","type":"Boolean","description":"Call Texture.destroy on the current texture before replacing it with the new one?","default":"","optional":true,"nullable":""}]},{"name":"onTextureUpdate","description":"When the texture is updated, this event will fire to update the scale and frame","parameters":[{"name":"event","type":"","description":"-","default":"","optional":"","nullable":""}]},{"name":"getBounds","description":"Returns the bounds of the Sprite as a rectangle.\nThe bounds calculation takes the worldTransform into account.\n\nIt is important to note that the transform is not updated when you call this method.\nSo if this Sprite is the child of a Display Object which has had its transform\nupdated since the last render pass, those changes will not yet have been applied\nto this Sprites worldTransform. If you need to ensure that all parent transforms\nare factored into this getBounds operation then you should call `updateTransform`\non the root most object in this Sprites display list first.","parameters":[{"name":"matrix","type":"Matrix","description":"the transformation matrix of the sprite","default":"","optional":"","nullable":""}],"returns":{"type":"Rectangle","description":"the framing rectangle"}},{"name":"getLocalBounds","description":"Retrieves the non-global local bounds of the Sprite as a rectangle. The calculation takes all visible children into consideration.","parameters":[],"returns":{"type":"Rectangle","description":"The rectangular bounding area"}},{"name":"_renderWebGL","description":"Renders the object using the WebGL renderer","parameters":[{"name":"renderSession","type":"RenderSession","description":"-","default":"","optional":"","nullable":""},{"name":"matrix","type":"Matrix","description":"- Optional matrix. If provided the Display Object will be rendered using this matrix, otherwise it will use its worldTransform.","default":"","optional":true,"nullable":""}]},{"name":"_renderCanvas","description":"Renders the object using the Canvas renderer","parameters":[{"name":"renderSession","type":"RenderSession","description":"-","default":"","optional":"","nullable":""},{"name":"matrix","type":"Matrix","description":"- Optional matrix. If provided the Display Object will be rendered using this matrix, otherwise it will use its worldTransform.","default":"","optional":true,"nullable":""}]},{"name":"addChild","description":"Adds a child to the container.","parameters":[{"name":"child","type":"PIXI.DisplayObject","description":"The DisplayObject to add to the container","default":"","optional":"","nullable":""}],"returns":{"type":"PIXI.DisplayObject","description":"The child that was added."}},{"name":"addChildAt","description":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","parameters":[{"name":"child","type":"PIXI.DisplayObject","description":"The child to add","default":"","optional":"","nullable":""},{"name":"index","type":"Number","description":"The index to place the child in","default":"","optional":"","nullable":""}],"returns":{"type":"PIXI.DisplayObject","description":"The child that was added."}},{"name":"swapChildren","description":"Swaps the position of 2 Display Objects within this container.","parameters":[{"name":"child","type":"PIXI.DisplayObject","description":"-","default":"","optional":"","nullable":""},{"name":"child2","type":"PIXI.DisplayObject","description":"-","default":"","optional":"","nullable":""}]},{"name":"getChildIndex","description":"Returns the index position of a child DisplayObject instance","parameters":[{"name":"child","type":"PIXI.DisplayObject","description":"The DisplayObject instance to identify","default":"","optional":"","nullable":""}],"returns":{"type":"Number","description":"The index position of the child display object to identify"}},{"name":"setChildIndex","description":"Changes the position of an existing child in the display object container","parameters":[{"name":"child","type":"PIXI.DisplayObject","description":"The child DisplayObject instance for which you want to change the index number","default":"","optional":"","nullable":""},{"name":"index","type":"Number","description":"The resulting index number for the child display object","default":"","optional":"","nullable":""}]},{"name":"getChildAt","description":"Returns the child at the specified index","parameters":[{"name":"index","type":"Number","description":"The index to get the child from","default":"","optional":"","nullable":""}],"returns":{"type":"PIXI.DisplayObject","description":"The child at the given index, if any."}},{"name":"removeChild","description":"Removes a child from the container.","parameters":[{"name":"child","type":"PIXI.DisplayObject","description":"The DisplayObject to remove","default":"","optional":"","nullable":""}],"returns":{"type":"PIXI.DisplayObject","description":"The child that was removed."}},{"name":"removeChildAt","description":"Removes a child from the specified index position.","parameters":[{"name":"index","type":"Number","description":"The index to get the child from","default":"","optional":"","nullable":""}],"returns":{"type":"PIXI.DisplayObject","description":"The child that was removed."}},{"name":"removeChildren","description":"Removes all children from this container that are within the begin and end indexes.","parameters":[{"name":"beginIndex","type":"Number","description":"The beginning position. Default value is 0.","default":"","optional":"","nullable":""},{"name":"endIndex","type":"Number","description":"The ending position. Default value is size of the container.","default":"","optional":"","nullable":""}]},{"name":"contains","description":"Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.","parameters":[{"name":"child","type":"PIXI.DisplayObject","description":"-","default":"","optional":"","nullable":""}],"returns":{"type":"Boolean","description":""}}],"members":[{"name":"anchor","access":"","virtual":false,"description":"The anchor sets the origin point of the texture.\nThe default is 0,0 this means the texture's origin is the top left\nSetting than anchor to 0.5,0.5 means the textures origin is centered\nSetting the anchor to 1,1 would mean the textures origin points will be the bottom right corner","type":{"names":["Point"]},"default":""},{"name":"texture","access":"","virtual":false,"description":"The texture that the sprite is using","type":{"names":["PIXI.Texture"]},"default":""},{"name":"_width","access":"private","virtual":false,"description":"The width of the sprite (this is initially set by the texture)","type":{"names":["Number"]},"default":""},{"name":"_height","access":"private","virtual":false,"description":"The height of the sprite (this is initially set by the texture)","type":{"names":["Number"]},"default":""},{"name":"tint","access":"","virtual":false,"description":"The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.","type":{"names":["Number"]},"default":"0xFFFFFF"},{"name":"cachedTint","access":"private","virtual":false,"description":"The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.","type":{"names":["Number"]},"default":"-1"},{"name":"tintedTexture","access":"","virtual":false,"description":"A canvas that contains the tinted version of the Sprite (in Canvas mode, WebGL doesn't populate this)","type":{"names":["Canvas"]},"default":"null"},{"name":"blendMode","access":"","virtual":false,"description":"The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.\n\nWarning: You cannot have a blend mode and a filter active on the same Sprite. Doing so will render the sprite invisible.","type":{"names":["Number"]},"default":"PIXI.blendModes.NORMAL;"},{"name":"shader","access":"","virtual":false,"description":"The shader that will be used to render this Sprite.\nSet to null to remove a current shader.","type":{"names":["PhaserFilter"]},"default":"null"},{"name":"exists","access":"","virtual":false,"description":"Controls if this Sprite is processed by the core Phaser game loops and Group loops.","type":{"names":["Boolean"]},"default":"true"},{"name":"width","access":"","virtual":false,"description":"The width of the sprite, setting this will actually modify the scale to achieve the value set","type":{"names":["Number"]},"default":""},{"name":"height","access":"","virtual":false,"description":"The height of the sprite, setting this will actually modify the scale to achieve the value set","type":{"names":["Number"]},"default":""},{"name":"children","access":"","virtual":false,"description":"[read-only] The array of children of this container.","type":{"names":["Array.<DisplayObject>"]},"default":""},{"name":"ignoreChildInput","access":"","virtual":false,"description":"If `ignoreChildInput` is `false` it will allow this objects _children_ to be considered as valid for Input events.\n\nIf this property is `true` then the children will _not_ be considered as valid for Input events.\n\nNote that this property isn't recursive: only immediate children are influenced, it doesn't scan further down.","type":{"names":["Boolean"]},"default":""},{"name":"position","access":"","virtual":false,"description":"The coordinates, in pixels, of this DisplayObject, relative to its parent container.\n\nThe value of this property does not reflect any positioning happening further up the display list.\nTo obtain that value please see the `worldPosition` property.","type":{"names":["PIXIPoint"]},"default":""},{"name":"scale","access":"","virtual":false,"description":"The scale of this DisplayObject. A scale of 1:1 represents the DisplayObject\nat its default size. A value of 0.5 would scale this DisplayObject by half, and so on.\n\nThe value of this property does not reflect any scaling happening further up the display list.\nTo obtain that value please see the `worldScale` property.","type":{"names":["PIXIPoint"]},"default":""},{"name":"pivot","access":"","virtual":false,"description":"The pivot point of this DisplayObject that it rotates around. The values are expressed\nin pixel values.","type":{"names":["PIXIPoint"]},"default":""},{"name":"rotation","access":"","virtual":false,"description":"The rotation of this DisplayObject. The value is given, and expressed, in radians, and is based on\na right-handed orientation.\n\nThe value of this property does not reflect any rotation happening further up the display list.\nTo obtain that value please see the `worldRotation` property.","type":{"names":["Number"]},"default":""},{"name":"alpha","access":"","virtual":false,"description":"The alpha value of this DisplayObject. A value of 1 is fully opaque. A value of 0 is transparent.\nPlease note that an object with an alpha value of 0 is skipped during the render pass.\n\nThe value of this property does not reflect any alpha values set further up the display list.\nTo obtain that value please see the `worldAlpha` property.","type":{"names":["Number"]},"default":""},{"name":"visible","access":"","virtual":false,"description":"The visibility of this DisplayObject. A value of `false` makes the object invisible.\nA value of `true` makes it visible. Please note that an object with a visible value of\n`false` is skipped during the render pass. Equally a DisplayObject with visible false will\nnot render any of its children.\n\nThe value of this property does not reflect any visible values set further up the display list.\nTo obtain that value please see the `worldVisible` property.","type":{"names":["Boolean"]},"default":""},{"name":"hitArea","access":"","virtual":false,"description":"This is the defined area that will pick up mouse / touch events. It is null by default.\nSetting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)","type":{"names":["Rectangle","Circle","Ellipse","Polygon"]},"default":""},{"name":"renderable","access":"","virtual":false,"description":"Should this DisplayObject be rendered by the renderer? An object with a renderable value of\n`false` is skipped during the render pass.","type":{"names":["Boolean"]},"default":""},{"name":"parent","access":"","virtual":false,"description":"The parent DisplayObjectContainer that this DisplayObject is a child of.\nAll DisplayObjects must belong to a parent in order to be rendered.\nThe root parent is the Stage object. This property is set automatically when the\nDisplayObject is added to, or removed from, a DisplayObjectContainer.","type":{"names":["PIXIDisplayObjectContainer"]},"default":""},{"name":"worldAlpha","access":"","virtual":false,"description":"The multiplied alpha value of this DisplayObject. A value of 1 is fully opaque. A value of 0 is transparent.\nThis value is the calculated total, based on the alpha values of all parents of this DisplayObjects \nin the display list.\n\nTo obtain, and set, the local alpha value, see the `alpha` property.\n\nNote: This property is only updated at the end of the `updateTransform` call, once per render. Until \nthat happens this property will contain values based on the previous frame. Be mindful of this if\naccessing this property outside of the normal game flow, i.e. from an asynchronous event callback.","type":{"names":["Number"]},"default":""},{"name":"worldTransform","access":"","virtual":false,"description":"The current transform of this DisplayObject.\n\nThis property contains the calculated total, based on the transforms of all parents of this \nDisplayObject in the display list.\n\nNote: This property is only updated at the end of the `updateTransform` call, once per render. Until \nthat happens this property will contain values based on the previous frame. Be mindful of this if\naccessing this property outside of the normal game flow, i.e. from an asynchronous event callback.","type":{"names":["PIXIMatrix"]},"default":""},{"name":"worldPosition","access":"","virtual":false,"description":"The coordinates, in pixels, of this DisplayObject within the world.\n\nThis property contains the calculated total, based on the positions of all parents of this \nDisplayObject in the display list.\n\nNote: This property is only updated at the end of the `updateTransform` call, once per render. Until \nthat happens this property will contain values based on the previous frame. Be mindful of this if\naccessing this property outside of the normal game flow, i.e. from an asynchronous event callback.","type":{"names":["PIXIPoint"]},"default":""},{"name":"worldScale","access":"","virtual":false,"description":"The global scale of this DisplayObject.\n\nThis property contains the calculated total, based on the scales of all parents of this \nDisplayObject in the display list.\n\nNote: This property is only updated at the end of the `updateTransform` call, once per render. Until \nthat happens this property will contain values based on the previous frame. Be mindful of this if\naccessing this property outside of the normal game flow, i.e. from an asynchronous event callback.","type":{"names":["PIXIPoint"]},"default":""},{"name":"worldRotation","access":"","virtual":false,"description":"The rotation, in radians, of this DisplayObject.\n\nThis property contains the calculated total, based on the rotations of all parents of this \nDisplayObject in the display list.\n\nNote: This property is only updated at the end of the `updateTransform` call, once per render. Until \nthat happens this property will contain values based on the previous frame. Be mindful of this if\naccessing this property outside of the normal game flow, i.e. from an asynchronous event callback.","type":{"names":["Number"]},"default":""},{"name":"filterArea","access":"","virtual":false,"description":"The rectangular area used by filters when rendering a shader for this DisplayObject.","type":{"names":["Rectangle"]},"default":""},{"name":"_sr","access":"private","virtual":false,"description":"","type":{"names":["Number"]},"default":""},{"name":"_cr","access":"private","virtual":false,"description":"","type":{"names":["Number"]},"default":""},{"name":"_bounds","access":"private","virtual":false,"description":"","type":{"names":["PIXIRectangle"]},"default":""},{"name":"_currentBounds","access":"private","virtual":false,"description":"","type":{"names":["PIXIRectangle"]},"default":""},{"name":"_mask","access":"private","virtual":false,"description":"","type":{"names":["PIXIRectangle"]},"default":""},{"name":"_cacheAsBitmap","access":"private","virtual":false,"description":"","type":{"names":["Boolean"]},"default":""},{"name":"_cacheIsDirty","access":"private","virtual":false,"description":"","type":{"names":["Boolean"]},"default":""},{"name":"x","access":"","virtual":false,"description":"The horizontal position of the DisplayObject, in pixels, relative to its parent.\nIf you need the world position of the DisplayObject, use `DisplayObject.worldPosition` instead.","type":{"names":["Number"]},"default":""},{"name":"y","access":"","virtual":false,"description":"The vertical position of the DisplayObject, in pixels, relative to its parent.\nIf you need the world position of the DisplayObject, use `DisplayObject.worldPosition` instead.","type":{"names":["Number"]},"default":""},{"name":"worldVisible","access":"","virtual":false,"description":"Indicates if this DisplayObject is visible, based on it, and all of its parents, `visible` property values.","type":{"names":["Boolean"]},"default":""},{"name":"mask","access":"","virtual":false,"description":"Sets a mask for this DisplayObject. A mask is an instance of a Graphics object.\nWhen applied it limits the visible area of this DisplayObject to the shape of the mask.\nUnder a Canvas renderer it uses shape clipping. Under a WebGL renderer it uses a Stencil Buffer.\nTo remove a mask, set this property to `null`.","type":{"names":["PIXIGraphics"]},"default":""},{"name":"filters","access":"","virtual":false,"description":"Sets the filters for this DisplayObject. This is a WebGL only feature, and is ignored by the Canvas\nRenderer. A filter is a shader applied to this DisplayObject. You can modify the placement of the filter\nusing `DisplayObject.filterArea`.\n\nTo remove filters, set this property to `null`.\n\nNote: You cannot have a filter set, and a MULTIPLY Blend Mode active, at the same time. Setting a \nfilter will reset this DisplayObjects blend mode to NORMAL.","type":{"names":["Array"]},"default":""},{"name":"cacheAsBitmap","access":"","virtual":false,"description":"Sets if this DisplayObject should be cached as a bitmap.\n\nWhen invoked it will take a snapshot of the DisplayObject, as it is at that moment, and store it \nin a RenderTexture. This is then used whenever this DisplayObject is rendered. It can provide a\nperformance benefit for complex, but static, DisplayObjects. I.e. those with lots of children.\n\nCached Bitmaps do not track their parents. If you update a property of this DisplayObject, it will not\nre-generate the cached bitmap automatically. To do that you need to call `DisplayObject.updateCache`.\n\nTo remove a cached bitmap, set this property to `null`.","type":{"names":["Boolean"]},"default":""}]},{"name":"PIXI.CanvasBuffer","description":"Creates a Canvas element of the given size.","constructor":{"name":"CanvasBuffer","description":"Creates a Canvas element of the given size.","parameters":[{"name":"width","type":"Number","description":"the width for the newly created canvas","default":"","optional":"","nullable":""},{"name":"height","type":"Number","description":"the height for the newly created canvas","default":"","optional":"","nullable":""}]},"functions":[{"name":"clear","description":"Clears the canvas that was created by the CanvasBuffer class.","parameters":[]},{"name":"resize","description":"Resizes the canvas to the specified width and height.","parameters":[{"name":"width","type":"Number","description":"the new width of the canvas","default":"","optional":"","nullable":""},{"name":"height","type":"Number","description":"the new height of the canvas","default":"","optional":"","nullable":""}]},{"name":"destroy","description":"Frees the canvas up for use again.","parameters":[]}],"members":[{"name":"width","access":"","virtual":false,"description":"The width of the Canvas in pixels.","type":{"names":["Number"]},"default":""},{"name":"height","access":"","virtual":false,"description":"The height of the Canvas in pixels.","type":{"names":["Number"]},"default":""},{"name":"canvas","access":"","virtual":false,"description":"The Canvas object that belongs to this CanvasBuffer.","type":{"names":["HTMLCanvasElement"]},"default":""},{"name":"context","access":"","virtual":false,"description":"A CanvasRenderingContext2D object representing a two-dimensional rendering context.","type":{"names":["CanvasRenderingContext2D"]},"default":""}]},{"name":"PIXI.CanvasMaskManager","description":"A set of functions used to handle masking.","constructor":{"name":"CanvasMaskManager","description":"A set of functions used to handle masking.","parameters":[]},"functions":[{"name":"pushMask","description":"This method adds it to the current stack of masks.","parameters":[{"name":"maskData","type":"Object","description":"the maskData that will be pushed","default":"","optional":"","nullable":""},{"name":"renderSession","type":"Object","description":"The renderSession whose context will be used for this mask manager.","default":"","optional":"","nullable":""}]},{"name":"popMask","description":"Restores the current drawing context to the state it was before the mask was applied.","parameters":[{"name":"renderSession","type":"Object","description":"The renderSession whose context will be used for this mask manager.","default":"","optional":"","nullable":""}]}],"members":[]},{"name":"PIXI.CanvasTinter","description":"Utility methods for Sprite/Texture tinting.","constructor":{"name":"CanvasTinter","description":"Utility methods for Sprite/T