Home

class: ParticleContainer

The ParticleContainer class is a really fast version of the Container built solely for speed,
so use when you need a lot of sprites or particles. The tradeoff of the ParticleContainer is that advanced
functionality will not work. ParticleContainer implements only the basic object transform (position, scale, rotation).
Any other functionality like tinting, masking, etc will not work on sprites in this batch.

It's extremely easy to use :

let container = new ParticleContainer();

for (let i = 0; i < 100; ++i)
{
    let sprite = new PIXI.Sprite.fromImage("myImage.png");
    container.addChild(sprite);
}

And here you have a hundred sprites that will be renderer at the speed of light.

Extends:

EventEmitter → DisplayObject → Container → ParticleContainer

Methods summary

Public methods
public	setProperties(properties: object): void
private	updateTransform(): void
private	renderWebGL(renderer: PIXI.WebGLRenderer): void
private	onChildrenChange(smallestChildIndex: number): void
private	renderCanvas(renderer: PIXI.CanvasRenderer): void
public	destroy(options: object, boolean): void
public	setProperties(properties: object): void
private	updateTransform(): void
private	renderWebGL(renderer: PIXI.WebGLRenderer): void
private	onChildrenChange(smallestChildIndex: number): void
private	renderCanvas(renderer: PIXI.CanvasRenderer): void
public	destroy(options: object, boolean): void
public	addChild(child: PIXI.DisplayObject): PIXI.DisplayObject
public	addChildAt(child: PIXI.DisplayObject, index: number): PIXI.DisplayObject
public	swapChildren(child: PIXI.DisplayObject, child2: PIXI.DisplayObject): void
public	getChildIndex(child: PIXI.DisplayObject): number
public	setChildIndex(child: PIXI.DisplayObject, index: number): void
public	getChildAt(index: number): PIXI.DisplayObject
public	removeChild(child: PIXI.DisplayObject): PIXI.DisplayObject
public	removeChildAt(index: number): PIXI.DisplayObject
public	removeChildren(beginIndex: number, endIndex: number): Array.<DisplayObject>
public	calculateBounds(): void
public	_calculateBounds(): void
private	renderAdvancedWebGL(renderer: PIXI.WebGLRenderer): void
private	_renderWebGL(renderer: PIXI.WebGLRenderer): void
private	_renderCanvas(renderer: PIXI.CanvasRenderer): void
public	width(): void
public	height(): void
private	_tempDisplayObjectParent(): void
public	_recursivePostUpdateTransform(): void
public	getBounds(skipUpdate: boolean, rect: PIXI.Rectangle): PIXI.Rectangle
public	getLocalBounds(rect: PIXI.Rectangle): PIXI.Rectangle
public	toGlobal(position: PIXI.Point, point: PIXI.Point, skipUpdate: boolean): PIXI.Point
public	toLocal(position: PIXI.Point, from: PIXI.DisplayObject, point: PIXI.Point, skipUpdate: boolean): PIXI.Point
public	setParent(container: PIXI.Container): PIXI.Container
public	setTransform(x: number, y: number, scaleX: number, scaleY: number, rotation: number, skewX: number, skewY: number, pivotX: number, pivotY: number): PIXI.DisplayObject
public	x(): void
public	y(): void
public	worldTransform(): void
public	localTransform(): void
public	position(): void
public	scale(): void
public	pivot(): void
public	skew(): void
public	rotation(): void
public	worldVisible(): void
public	mask(): void
public	filters(): void

Properties

Name	Type	Attribute	Description
_properties	Array.<boolean>	private	Set properties to be dynamic (true) / static (false)
_maxSize	number	private
_batchSize	number	private
_glBuffers	object.<number, WebGLBuffer>	private
_bufferToUpdate	number	private
interactiveChildren	boolean	public
blendMode	number	public	The blend mode to be applied to the sprite. Apply a value of `PIXI.BLEND_MODES.NORMAL` to reset the blend mode.
roundPixels	boolean	public	Used for canvas renderering. If true then the elements will be positioned at the nearest pixel. This provides a nice speed boost.
baseTexture	BaseTexture	public	The texture used to render the children.
_properties	Array.<boolean>	private	Set properties to be dynamic (true) / static (false)
_maxSize	number	private
_batchSize	number	private
_glBuffers	object.<number, WebGLBuffer>	private
_bufferToUpdate	number	private
interactiveChildren	boolean	public
blendMode	number	public	The blend mode to be applied to the sprite. Apply a value of `PIXI.BLEND_MODES.NORMAL` to reset the blend mode.
roundPixels	boolean	public	Used for canvas renderering. If true then the elements will be positioned at the nearest pixel. This provides a nice speed boost.
baseTexture	BaseTexture	public	The texture used to render the children.
children	Array.	public	The array of children of this container.
transform	PIXI.TransformBase	public	World transform and local transform of this object. This will become read-only later, please do not assign anything there unless you know what are you doing
alpha	number	public	The opacity of the object.
visible	boolean	public	The visibility of the object. If false the object will not be drawn, and the updateTransform function will not be called. Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually
renderable	boolean	public	Can this object be rendered, if false the object will not be drawn but the updateTransform methods will still be called. Only affects recursive calls from parent. You can ask for bounds manually
parent	PIXI.Container	public	The display object container that contains this display object.
worldAlpha	number	public	The multiplied alpha of the displayObject
filterArea	PIXI.Rectangle	public	The area the filter is applied to. This is used as more of an optimisation rather than figuring out the dimensions of the displayObject each frame you can set this rectangle Also works as an interaction mask
_bounds	PIXI.Rectangle	private	The bounds object, this is used to calculate and store the bounds of the displayObject
_mask	PIXI.Graphics PIXI.Sprite	private	The original, cached mask of the object
_destroyed	boolean	private	If the object has been destroyed via destroy(). If true, it should not be used.
cacheAsBitmap	boolean	public	Set this to true if you want this display object to be cached as a bitmap. This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects. To remove simply set this property to 'false' IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.

Methods

setProperties(properties: object): void

particles\ParticleContainer.js, line 133

Sets the private properties array to dynamic / static based on the passed properties object

Params:

Name	Type	Attribute	Description
properties			The properties to be uploaded

Returns:

void

updateTransform(): void

particles\ParticleContainer.js, line 150

Updates the object transform for rendering

Returns:

void

renderWebGL(renderer: PIXI.WebGLRenderer): void

particles\ParticleContainer.js, line 163

Renders the container using the WebGL renderer

Params:

Name	Type	Attribute	Description
renderer			The webgl renderer

Returns:

void

onChildrenChange(smallestChildIndex: number): void

particles\ParticleContainer.js, line 189

Set the flag that static data should be updated to true

Params:

Name	Type	Attribute	Description
smallestChildIndex			The smallest child index

Returns:

void

renderCanvas(renderer: PIXI.CanvasRenderer): void

particles\ParticleContainer.js, line 205

Renders the object using the Canvas renderer

Params:

Name	Type	Attribute	Description
renderer			The canvas renderer

Returns:

void

destroy(options: object, boolean): void

particles\ParticleContainer.js, line 338

Destroys the container

Params:

Name	Type	Attribute	Description
options			Options parameter. A boolean will act as if all options have been set to that value
options.children			if set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.
options.texture			Only used for child Sprites if options.children is set to true Should it destroy the texture of the child sprite
options.baseTexture			Only used for child Sprites if options.children is set to true Should it destroy the base texture of the child sprite

Returns:

void

setProperties(properties: object): void

particles\ParticleContainer.js, line 133

Sets the private properties array to dynamic / static based on the passed properties object

Params:

Name	Type	Attribute	Description
properties			The properties to be uploaded

Returns:

void

updateTransform(): void

particles\ParticleContainer.js, line 150

Updates the object transform for rendering

Returns:

void

renderWebGL(renderer: PIXI.WebGLRenderer): void

particles\ParticleContainer.js, line 163

Renders the container using the WebGL renderer

Params:

Name	Type	Attribute	Description
renderer			The webgl renderer

Returns:

void

onChildrenChange(smallestChildIndex: number): void

particles\ParticleContainer.js, line 189

Set the flag that static data should be updated to true

Params:

Name	Type	Attribute	Description
smallestChildIndex			The smallest child index

Returns:

void

renderCanvas(renderer: PIXI.CanvasRenderer): void

particles\ParticleContainer.js, line 205

Renders the object using the Canvas renderer

Params:

Name	Type	Attribute	Description
renderer			The canvas renderer

Returns:

void

destroy(options: object, boolean): void

particles\ParticleContainer.js, line 338

Destroys the container

Params:

Name	Type	Attribute	Description
options			Options parameter. A boolean will act as if all options have been set to that value
options.children			if set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.
options.texture			Only used for child Sprites if options.children is set to true Should it destroy the texture of the child sprite
options.baseTexture			Only used for child Sprites if options.children is set to true Should it destroy the base texture of the child sprite

Returns:

void

addChild(child: PIXI.DisplayObject): PIXI.DisplayObject

core\display\Container.js, line 55

Adds one or more children to the container.

Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)

Params:

Name	Type	Attribute	Description
child			The DisplayObject(s) to add to the container

Returns:

PIXI.DisplayObject

addChildAt(child: PIXI.DisplayObject, index: number): PIXI.DisplayObject

core\display\Container.js, line 101

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Params:

Name	Type	Attribute	Description
child			The child to add
index			The index to place the child in

Returns:

PIXI.DisplayObject

swapChildren(child: PIXI.DisplayObject, child2: PIXI.DisplayObject): void

core\display\Container.js, line 135

Swaps the position of 2 Display Objects within this container.

Params:

Name	Type	Attribute	Description
child			First display object to swap
child2			Second display object to swap

Returns:

void

getChildIndex(child: PIXI.DisplayObject): number

core\display\Container.js, line 156

Returns the index position of a child DisplayObject instance

Params:

Name	Type	Attribute	Description
child			The DisplayObject instance to identify

Returns:

number

setChildIndex(child: PIXI.DisplayObject, index: number): void

core\display\Container.js, line 174

Changes the position of an existing child in the display object container

Params:

Name	Type	Attribute	Description
child			The child DisplayObject instance for which you want to change the index number
index			The resulting index number for the child display object

Returns:

void

getChildAt(index: number): PIXI.DisplayObject

core\display\Container.js, line 195

Returns the child at the specified index

Params:

Name	Type	Attribute	Description
index			The index to get the child at

Returns:

PIXI.DisplayObject

removeChild(child: PIXI.DisplayObject): PIXI.DisplayObject

core\display\Container.js, line 211

Removes one or more children from the container.

Params:

Name	Type	Attribute	Description
child			The DisplayObject(s) to remove

Returns:

PIXI.DisplayObject

removeChildAt(index: number): PIXI.DisplayObject

core\display\Container.js, line 253

Removes a child from the specified index position.

Params:

Name	Type	Attribute	Description
index			The index to get the child from

Returns:

PIXI.DisplayObject

removeChildren(beginIndex: number, endIndex: number): Array.<DisplayObject>

core\display\Container.js, line 279

Removes all children from this container that are within the begin and end indexes.

Params:

Name	Type	Attribute	Description
beginIndex			The beginning position.
endIndex			The ending position. Default value is size of the container.

Returns:

Array.<DisplayObject>

calculateBounds(): void

core\display\Container.js, line 345

Recalculates the bounds of the container.

Returns:

void

_calculateBounds(): void

core\display\Container.js, line 386

Recalculates the bounds of the object. Override this to
calculate the bounds of the specific object (not including children).

Returns:

void

renderAdvancedWebGL(renderer: PIXI.WebGLRenderer): void

core\display\Container.js, line 427

Render the object using the WebGL renderer and advanced features.

Params:

Name	Type	Attribute	Description
renderer			The renderer

Returns:

void

_renderWebGL(renderer: PIXI.WebGLRenderer): void

core\display\Container.js, line 491

To be overridden by the subclasses.

Params:

Name	Type	Attribute	Description
renderer			The renderer

Returns:

void

_renderCanvas(renderer: PIXI.CanvasRenderer): void

core\display\Container.js, line 502

To be overridden by the subclass

Params:

Name	Type	Attribute	Description
renderer			The renderer

Returns:

void

width(): void

core\display\Container.js, line 572

The width of the Container, setting this will actually modify the scale to achieve the value set

Returns:

void

height(): void

core\display\Container.js, line 598

The height of the Container, setting this will actually modify the scale to achieve the value set

Returns:

void

_tempDisplayObjectParent(): void

core\display\DisplayObject.js, line 133

Returns:

void

_recursivePostUpdateTransform(): void

core\display\DisplayObject.js, line 161

recursively updates transform of all objects from the root to this one
internal function for toLocal()

Returns:

void

getBounds(skipUpdate: boolean, rect: PIXI.Rectangle): PIXI.Rectangle

core\display\DisplayObject.js, line 183

Retrieves the bounds of the displayObject as a rectangle object.

Params:

Name	Type	Attribute	Description
skipUpdate			setting to true will stop the transforms of the scene graph from being updated. This means the calculation returned MAY be out of date BUT will give you a nice performance boost
rect			Optional rectangle to store the result of the bounds calculation

Returns:

PIXI.Rectangle

getLocalBounds(rect: PIXI.Rectangle): PIXI.Rectangle

core\display\DisplayObject.js, line 224

Retrieves the local bounds of the displayObject as a rectangle object

Params:

Name	Type	Attribute	Description
rect			Optional rectangle to store the result of the bounds calculation

Returns:

PIXI.Rectangle

toGlobal(position: PIXI.Point, point: PIXI.Point, skipUpdate: boolean): PIXI.Point

core\display\DisplayObject.js, line 259

Calculates the global position of the display object

Params:

Name	Type	Attribute	Description
position			The world origin to calculate from
point			A Point object in which to store the value, optional (otherwise will create a new Point)
skipUpdate			Should we skip the update transform.

Returns:

PIXI.Point

toLocal(position: PIXI.Point, from: PIXI.DisplayObject, point: PIXI.Point, skipUpdate: boolean): PIXI.Point

core\display\DisplayObject.js, line 294

Calculates the local position of the display object relative to another point

Params:

Name	Type	Attribute	Description
position			The world origin to calculate from
from			The DisplayObject to calculate the global position from
point			A Point object in which to store the value, optional (otherwise will create a new Point)
skipUpdate			Should we skip the update transform

Returns:

PIXI.Point

setParent(container: PIXI.Container): PIXI.Container

core\display\DisplayObject.js, line 350

Set the parent Container of this DisplayObject

Params:

Name	Type	Attribute	Description
container			The Container to add this DisplayObject to

Returns:

PIXI.Container

setTransform(x: number, y: number, scaleX: number, scaleY: number, rotation: number, skewX: number, skewY: number, pivotX: number, pivotY: number): PIXI.DisplayObject

core\display\DisplayObject.js, line 376

Convenience function to set the position, scale, skew and pivot at once.

Params:

Name	Type	Attribute	Description
x			The X position
y			The Y position
scaleX			The X scale value
scaleY			The Y scale value
rotation			The rotation
skewX			The X skew value
skewY			The Y skew value
pivotX			The X pivot value
pivotY			The Y pivot value

Returns:

PIXI.DisplayObject

x(): void

core\display\DisplayObject.js, line 427

The position of the displayObject on the x axis relative to the local coordinates of the parent.
An alias to position.x

Returns:

void

y(): void

core\display\DisplayObject.js, line 443

The position of the displayObject on the y axis relative to the local coordinates of the parent.
An alias to position.y

Returns:

void

worldTransform(): void

core\display\DisplayObject.js, line 459

Current transform of the object based on world (parent) factors

Returns:

void

localTransform(): void

core\display\DisplayObject.js, line 470

Current transform of the object based on local factors: position, scale, other stuff

Returns:

void

position(): void

core\display\DisplayObject.js, line 481

The coordinate of the object relative to the local coordinates of the parent.
Assignment by value since pixi-v4.

Returns:

void

scale(): void

core\display\DisplayObject.js, line 497

The scale factor of the object.
Assignment by value since pixi-v4.

Returns:

void

pivot(): void

core\display\DisplayObject.js, line 513

The pivot point of the displayObject that it rotates around
Assignment by value since pixi-v4.

Returns:

void

skew(): void

core\display\DisplayObject.js, line 529

The skew factor for the object in radians.
Assignment by value since pixi-v4.

Returns:

void

rotation(): void

core\display\DisplayObject.js, line 544

The rotation of the object in radians.

Returns:

void

worldVisible(): void

core\display\DisplayObject.js, line 560

Indicates if the object is globally visible.

Returns:

void

mask(): void

core\display\DisplayObject.js, line 587

Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it. In PIXI a regular mask must be a
PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it
utilises shape clipping. To remove a mask, set this property to null.

Returns:

void

filters(): void

core\display\DisplayObject.js, line 614

Sets the filters for the displayObject.

IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
To remove filters simply set this property to 'null'

Returns:

void

{ "comment": "/**\n * The ParticleContainer class is a really fast version of the Container built solely for speed,\n * so use when you need a lot of sprites or particles. The tradeoff of the ParticleContainer is that advanced\n * functionality will not work. ParticleContainer implements only the basic object transform (position, scale, rotation).\n * Any other functionality like tinting, masking, etc will not work on sprites in this batch.\n *\n * It's extremely easy to use :\n *\n * ```js\n * let container = new ParticleContainer();\n *\n * for (let i = 0; i < 100; ++i)\n * {\n * let sprite = new PIXI.Sprite.fromImage(\"myImage.png\");\n * container.addChild(sprite);\n * }\n * ```\n *\n * And here you have a hundred sprites that will be renderer at the speed of light.\n *\n * @class\n * @extends PIXI.Container\n * @memberof PIXI.particles\n */", "meta": { "range": [ 896, 11540 ], "filename": "ParticleContainer.js", "lineno": 29, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles", "code": { "id": "astnode100070347", "name": "ParticleContainer", "type": "ClassDeclaration", "paramnames": [ "maxSize", "properties", "batchSize" ] } }, "classdesc": "

It's extremely easy to use :

let container = new ParticleContainer();\n\nfor (let i = 0; i < 100; ++i)\n{\n    let sprite = new PIXI.Sprite.fromImage("myImage.png");\n    container.addChild(sprite);\n}

And here you have a hundred sprites that will be renderer at the speed of light.

", "kind": "class", "augments": [ "PIXI.Container" ], "memberof": "PIXI.particles", "name": "ParticleContainer", "longname": "PIXI.particles.ParticleContainer", "scope": "static", "params": [ { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 15000, "description": "

The maximum number of particles that can be renderer by the container.

", "name": "maxSize" }, { "type": { "names": [ "object" ] }, "optional": true, "description": "

The properties of children that should be uploaded to the gpu and applied.

", "name": "properties" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "

When true, scale be uploaded and applied.

", "name": "properties.scale" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": true, "description": "

When true, position be uploaded and applied.

", "name": "properties.position" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "

When true, rotation be uploaded and applied.

", "name": "properties.rotation" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "

When true, uvs be uploaded and applied.

", "name": "properties.uvs" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "

When true, alpha be uploaded and applied.

", "name": "properties.alpha" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 15000, "description": "

Number of particles per batch.

", "name": "batchSize" } ], "___id": "T000002R006547", "___s": true, "$methods": [ { "comment": "/**\n * Sets the private properties array to dynamic / static based on the passed properties object\n *\n * @param {object} properties - The properties to be uploaded\n */", "meta": { "range": [ 4419, 5008 ], "filename": "ParticleContainer.js", "lineno": 133, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles", "code": { "id": "astnode100070458", "name": "ParticleContainer#setProperties", "type": "MethodDefinition", "paramnames": [ "properties" ] }, "vars": { "": null } }, "description": "

Sets the private properties array to dynamic / static based on the passed properties object

", "params": [ { "type": { "names": [ "object" ] }, "description": "

The properties to be uploaded

", "name": "properties" } ], "name": "setProperties", "longname": "PIXI.particles.ParticleContainer#setProperties", "kind": "function", "memberof": "PIXI.particles.ParticleContainer", "scope": "instance", "___id": "T000002R006570", "___s": true, "skip": true, "slug": "PIXI.particles.ParticleContainersetProperties", "filepath": "particles\\ParticleContainer.js" }, { "comment": "/**\n * Updates the object transform for rendering\n *\n * @private\n */", "meta": { "range": [ 5103, 5275 ], "filename": "ParticleContainer.js", "lineno": 150, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles", "code": { "id": "astnode100070571", "name": "ParticleContainer#updateTransform", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Updates the object transform for rendering

", "access": "private", "name": "updateTransform", "longname": "PIXI.particles.ParticleContainer#updateTransform", "kind": "function", "memberof": "PIXI.particles.ParticleContainer", "scope": "instance", "params": [], "overrides": "PIXI.Container#updateTransform", "___id": "T000002R006576", "___s": true, "skip": true, "slug": "PIXI.particles.ParticleContainerupdateTransform", "filepath": "particles\\ParticleContainer.js" }, { "comment": "/**\n * Renders the container using the WebGL renderer\n *\n * @private\n * @param {PIXI.WebGLRenderer} renderer - The webgl renderer\n */", "meta": { "range": [ 5439, 5996 ], "filename": "ParticleContainer.js", "lineno": 163, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles", "code": { "id": "astnode100070580", "name": "ParticleContainer#renderWebGL", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the container using the WebGL renderer

", "access": "private", "params": [ { "type": { "names": [ "PIXI.WebGLRenderer" ] }, "description": "

The webgl renderer

", "name": "renderer" } ], "name": "renderWebGL", "longname": "PIXI.particles.ParticleContainer#renderWebGL", "kind": "function", "memberof": "PIXI.particles.ParticleContainer", "scope": "instance", "overrides": "PIXI.Container#renderWebGL", "___id": "T000002R006577", "___s": true, "skip": true, "slug": "PIXI.particles.ParticleContainerrenderWebGL", "filepath": "particles\\ParticleContainer.js" }, { "comment": "/**\n * Set the flag that static data should be updated to true\n *\n * @private\n * @param {number} smallestChildIndex - The smallest child index\n */", "meta": { "range": [ 6173, 6416 ], "filename": "ParticleContainer.js", "lineno": 189, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles", "code": { "id": "astnode100070672", "name": "ParticleContainer#onChildrenChange", "type": "MethodDefinition", "paramnames": [ "smallestChildIndex" ] }, "vars": { "": null } }, "description": "

Set the flag that static data should be updated to true

", "access": "private", "params": [ { "type": { "names": [ "number" ] }, "description": "

The smallest child index

", "name": "smallestChildIndex" } ], "name": "onChildrenChange", "longname": "PIXI.particles.ParticleContainer#onChildrenChange", "kind": "function", "memberof": "PIXI.particles.ParticleContainer", "scope": "instance", "overrides": "PIXI.Container#onChildrenChange", "___id": "T000002R006579", "___s": true, "skip": true, "slug": "PIXI.particles.ParticleContaineronChildrenChange", "filepath": "particles\\ParticleContainer.js" }, { "comment": "/**\n * Renders the object using the Canvas renderer\n *\n * @private\n * @param {PIXI.CanvasRenderer} renderer - The canvas renderer\n */", "meta": { "range": [ 6580, 10507 ], "filename": "ParticleContainer.js", "lineno": 205, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles", "code": { "id": "astnode100070702", "name": "ParticleContainer#renderCanvas", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the Canvas renderer

", "access": "private", "params": [ { "type": { "names": [ "PIXI.CanvasRenderer" ] }, "description": "

The canvas renderer

", "name": "renderer" } ], "name": "renderCanvas", "longname": "PIXI.particles.ParticleContainer#renderCanvas", "kind": "function", "memberof": "PIXI.particles.ParticleContainer", "scope": "instance", "overrides": "PIXI.Container#renderCanvas", "___id": "T000002R006582", "___s": true, "skip": true, "slug": "PIXI.particles.ParticleContainerrenderCanvas", "filepath": "particles\\ParticleContainer.js" }, { "comment": "/**\n * Destroys the container\n *\n * @param {object|boolean} [options] - Options parameter. A boolean will act as if all options\n * have been set to that value\n * @param {boolean} [options.children=false] - if set to true, all the children will have their\n * destroy method called as well. 'options' will be passed on to those calls.\n * @param {boolean} [options.texture=false] - Only used for child Sprites if options.children is set to true\n * Should it destroy the texture of the child sprite\n * @param {boolean} [options.baseTexture=false] - Only used for child Sprites if options.children is set to true\n * Should it destroy the base texture of the child sprite\n */", "meta": { "range": [ 11235, 11538 ], "filename": "ParticleContainer.js", "lineno": 338, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles", "code": { "id": "astnode100071175", "name": "ParticleContainer#destroy", "type": "MethodDefinition", "paramnames": [ "options" ] }, "vars": { "": null } }, "description": "

Destroys the container

", "params": [ { "type": { "names": [ "object", "boolean" ] }, "optional": true, "description": "

Options parameter. A boolean will act as if all options
have been set to that value

", "name": "options" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "

if set to true, all the children will have their
destroy method called as well. 'options' will be passed on to those calls.

", "name": "options.children" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "

Only used for child Sprites if options.children is set to true
Should it destroy the texture of the child sprite

", "name": "options.texture" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "

Only used for child Sprites if options.children is set to true
Should it destroy the base texture of the child sprite

", "name": "options.baseTexture" } ], "name": "destroy", "longname": "PIXI.particles.ParticleContainer#destroy", "kind": "function", "memberof": "PIXI.particles.ParticleContainer", "scope": "instance", "overrides": "PIXI.Container#destroy", "___id": "T000002R006609", "___s": true, "skip": true, "slug": "PIXI.particles.ParticleContainerdestroy", "filepath": "particles\\ParticleContainer.js" }, { "comment": "/**\n * Sets the private properties array to dynamic / static based on the passed properties object\n *\n * @param {object} properties - The properties to be uploaded\n */", "meta": { "range": [ 4419, 5008 ], "filename": "ParticleContainer.js", "lineno": 133, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles", "code": { "id": "astnode100145137", "name": "ParticleContainer#setProperties", "type": "MethodDefinition", "paramnames": [ "properties" ] }, "vars": { "": null } }, "description": "

Sets the private properties array to dynamic / static based on the passed properties object

", "params": [ { "type": { "names": [ "object" ] }, "description": "

The properties to be uploaded

", "name": "properties" } ], "name": "setProperties", "longname": "PIXI.particles.ParticleContainer#setProperties", "kind": "function", "memberof": "PIXI.particles.ParticleContainer", "scope": "instance", "___id": "T000002R013504", "___s": true, "skip": true, "slug": "PIXI.particles.ParticleContainersetProperties", "filepath": "particles\\ParticleContainer.js" }, { "comment": "/**\n * Updates the object transform for rendering\n *\n * @private\n */", "meta": { "range": [ 5103, 5275 ], "filename": "ParticleContainer.js", "lineno": 150, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles", "code": { "id": "astnode100145250", "name": "ParticleContainer#updateTransform", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Updates the object transform for rendering

", "access": "private", "name": "updateTransform", "longname": "PIXI.particles.ParticleContainer#updateTransform", "kind": "function", "memberof": "PIXI.particles.ParticleContainer", "scope": "instance", "params": [], "overrides": "PIXI.Container#updateTransform", "___id": "T000002R013510", "___s": true, "skip": true, "slug": "PIXI.particles.ParticleContainerupdateTransform", "filepath": "particles\\ParticleContainer.js" }, { "comment": "/**\n * Renders the container using the WebGL renderer\n *\n * @private\n * @param {PIXI.WebGLRenderer} renderer - The webgl renderer\n */", "meta": { "range": [ 5439, 5996 ], "filename": "ParticleContainer.js", "lineno": 163, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles", "code": { "id": "astnode100145259", "name": "ParticleContainer#renderWebGL", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the container using the WebGL renderer

", "access": "private", "params": [ { "type": { "names": [ "PIXI.WebGLRenderer" ] }, "description": "

The webgl renderer

", "name": "renderer" } ], "name": "renderWebGL", "longname": "PIXI.particles.ParticleContainer#renderWebGL", "kind": "function", "memberof": "PIXI.particles.ParticleContainer", "scope": "instance", "overrides": "PIXI.Container#renderWebGL", "___id": "T000002R013511", "___s": true, "skip": true, "slug": "PIXI.particles.ParticleContainerrenderWebGL", "filepath": "particles\\ParticleContainer.js" }, { "comment": "/**\n * Set the flag that static data should be updated to true\n *\n * @private\n * @param {number} smallestChildIndex - The smallest child index\n */", "meta": { "range": [ 6173, 6416 ], "filename": "ParticleContainer.js", "lineno": 189, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles", "code": { "id": "astnode100145351", "name": "ParticleContainer#onChildrenChange", "type": "MethodDefinition", "paramnames": [ "smallestChildIndex" ] }, "vars": { "": null } }, "description": "

Set the flag that static data should be updated to true

", "access": "private", "params": [ { "type": { "names": [ "number" ] }, "description": "

The smallest child index

", "name": "smallestChildIndex" } ], "name": "onChildrenChange", "longname": "PIXI.particles.ParticleContainer#onChildrenChange", "kind": "function", "memberof": "PIXI.particles.ParticleContainer", "scope": "instance", "overrides": "PIXI.Container#onChildrenChange", "___id": "T000002R013513", "___s": true, "skip": true, "slug": "PIXI.particles.ParticleContaineronChildrenChange", "filepath": "particles\\ParticleContainer.js" }, { "comment": "/**\n * Renders the object using the Canvas renderer\n *\n * @private\n * @param {PIXI.CanvasRenderer} renderer - The canvas renderer\n */", "meta": { "range": [ 6580, 10507 ], "filename": "ParticleContainer.js", "lineno": 205, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles", "code": { "id": "astnode100145381", "name": "ParticleContainer#renderCanvas", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the Canvas renderer

", "access": "private", "params": [ { "type": { "names": [ "PIXI.CanvasRenderer" ] }, "description": "

The canvas renderer

", "name": "renderer" } ], "name": "renderCanvas", "longname": "PIXI.particles.ParticleContainer#renderCanvas", "kind": "function", "memberof": "PIXI.particles.ParticleContainer", "scope": "instance", "overrides": "PIXI.Container#renderCanvas", "___id": "T000002R013516", "___s": true, "skip": true, "slug": "PIXI.particles.ParticleContainerrenderCanvas", "filepath": "particles\\ParticleContainer.js" }, { "comment": "/**\n * Destroys the container\n *\n * @param {object|boolean} [options] - Options parameter. A boolean will act as if all options\n * have been set to that value\n * @param {boolean} [options.children=false] - if set to true, all the children will have their\n * destroy method called as well. 'options' will be passed on to those calls.\n * @param {boolean} [options.texture=false] - Only used for child Sprites if options.children is set to true\n * Should it destroy the texture of the child sprite\n * @param {boolean} [options.baseTexture=false] - Only used for child Sprites if options.children is set to true\n * Should it destroy the base texture of the child sprite\n */", "meta": { "range": [ 11235, 11538 ], "filename": "ParticleContainer.js", "lineno": 338, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles", "code": { "id": "astnode100145854", "name": "ParticleContainer#destroy", "type": "MethodDefinition", "paramnames": [ "options" ] }, "vars": { "": null } }, "description": "