PIXI

Class: ParticleContainer

PIXI. ParticleContainer

new PIXI.ParticleContainer(maxSize, properties, batchSize)

core/particles/ParticleContainer.js, line 36

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 :

var container = new ParticleContainer();

for (var i = 0; i < 100; ++i)
{
    var 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.

Name Type Default Description
maxSize number 15000 optional

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

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

Name Type Default Description
scale boolean false optional

When true, scale be uploaded and applied.
position boolean true optional

When true, position be uploaded and applied.
rotation boolean false optional

When true, rotation be uploaded and applied.
uvs boolean false optional

When true, uvs be uploaded and applied.
alpha boolean false optional

When true, alpha be uploaded and applied.
batchSize number 15000 optional

Number of particles per batch.

Extends

Members

alphanumber

The opacity of the object.

blendModenumber

The blend mode to be applied to the sprite. Apply a value of PIXI.BLEND_MODES.NORMAL to reset the blend mode.

Default Value:
  • PIXI.BLEND_MODES.NORMAL
See:

cacheAsBitmapboolean

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'

readonlychildrenArray.<PIXI.DisplayObject>

The array of children of this container.

filterAreaPIXI.Rectangle

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

filtersArray.<PIXI.AbstractFilter>

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'

heightnumber

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

interactiveChildrenboolean

maskPIXI.Graphics PIXI.Sprite

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.

TODO
  • For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.

readonlyparentPIXI.Container

The display object container that contains this display object.

pivotPIXI.Point

The pivot point of the displayObject that it rotates around

positionPIXI.Point

The coordinate of the object relative to the local coordinates of the parent.

renderableboolean

Can this object be rendered, if false the object will not be drawn but the updateTransform
methods will still be called.

rotationnumber

The rotation of the object in radians.

roundPixelsboolean

Used for canvas renderering. If true then the elements will be positioned at the nearest pixel. This provides a nice speed boost.

Default Value:
  • true;

scalePIXI.Point

The scale factor of the object.

skewPIXI.Point

The skew factor for the object in radians.

visibleboolean

The visibility of the object. If false the object will not be drawn, and
the updateTransform function will not be called.

widthnumber

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

readonlyworldAlphanumber

The multiplied alpha of the displayObject

readonlyworldTransformPIXI.Matrix

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

readonlyworldVisibleboolean

Indicates if the sprite is globally visible.

xnumber

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

ynumber

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

Methods

inherited addChild(child){PIXI.DisplayObject}

core/display/Container.js, line 112

Adds a child to the container.

You can also add multple items like so: myContainer.addChild(thinkOne, thingTwo, thingThree)

Name Type Description
child PIXI.DisplayObject

The DisplayObject to add to the container
Returns:
Type Description
PIXI.DisplayObject The child that was added.

inherited addChildAt(child, index){PIXI.DisplayObject}

core/display/Container.js, line 153

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

Name Type Description
child PIXI.DisplayObject

The child to add
index number

The index to place the child in
Returns:
Type Description
PIXI.DisplayObject The child that was added.

destroy(destroyChildren)

core/particles/ParticleContainer.js, line 306

Destroys the container

Name Type Default Description
destroyChildren boolean false optional

if set to true, all the children will have their destroy method called as well

inherited generateTexture(renderer, resolution, scaleMode){PIXI.Texture}

core/display/Container.js, line 368

Useful function that returns a texture of the display object that can then be used to create sprites
This can be quite useful if your displayObject is static / complicated and needs to be reused multiple times.

Name Type Description
renderer PIXI.CanvasRenderer | PIXI.WebGLRenderer

The renderer used to generate the texture.
resolution number

The resolution of the texture being generated
scaleMode number

See PIXI.SCALE_MODES for possible values
Returns:
Type Description
PIXI.Texture a texture of the display object

inherited getBounds(){PIXI.Rectangle}

core/display/Container.js, line 410

Retrieves the bounds of the Container as a rectangle. The bounds calculation takes all visible children into consideration.

Returns:
Type Description
PIXI.Rectangle The rectangular bounding area

inherited getChildAt(index){PIXI.DisplayObject}

core/display/Container.js, line 248

Returns the child at the specified index

Name Type Description
index number

The index to get the child at
Returns:
Type Description
PIXI.DisplayObject The child at the given index, if any.

inherited getChildIndex(child){number}

core/display/Container.js, line 210

Returns the index position of a child DisplayObject instance

Name Type Description
child PIXI.DisplayObject

The DisplayObject instance to identify
Returns:
Type Description
number The index position of the child display object to identify

inherited getLocalBounds(){PIXI.Rectangle}

core/display/Container.js, line 486

Retrieves the non-global local bounds of the Container as a rectangle.
The calculation takes all visible children into consideration.

Returns:
Type Description
PIXI.Rectangle The rectangular bounding area

inherited removeChild(child){PIXI.DisplayObject}

core/display/Container.js, line 264

Removes a child from the container.

Name Type Description
child PIXI.DisplayObject

The DisplayObject to remove
Returns:
Type Description
PIXI.DisplayObject The child that was removed.

inherited removeChildAt(index){PIXI.DisplayObject}

core/display/Container.js, line 304

Removes a child from the specified index position.

Name Type Description
index number

The index to get the child from
Returns:
Type Description
PIXI.DisplayObject The child that was removed.

inherited removeChildren(beginIndex, endIndex)

core/display/Container.js, line 324

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

Name Type Description
beginIndex number

The beginning position. Default value is 0.
endIndex number

The ending position. Default value is size of the container.

inherited setChildIndex(child, index)

core/display/Container.js, line 228

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

Name Type Description
child PIXI.DisplayObject

The child DisplayObject instance for which you want to change the index number
index number

The resulting index number for the child display object

inherited setParent(container){Container}

core/display/DisplayObject.js, line 505

Set the parent Container of this DisplayObject

Name Type Description
container Container

The Container to add this DisplayObject to
Returns:
Type Description
Container The Container that this DisplayObject was added to

setProperties(properties)

core/particles/ParticleContainer.js, line 122

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

Name Type Description
properties object

The properties to be uploaded

inherited setTransform(x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY){PIXI.DisplayObject}

core/display/DisplayObject.js, line 530

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

Name Type Default Description
x number 0 optional

The X position
y number 0 optional

The Y position
scaleX number 1 optional

The X scale value
scaleY number 1 optional

The Y scale value
rotation number 0 optional

The rotation
skewX number 0 optional

The X skew value
skewY number 0 optional

The Y skew value
pivotX number 0 optional

The X pivot value
pivotY number 0 optional

The Y pivot value
Returns:
Type Description
PIXI.DisplayObject

inherited swapChildren(child, child2)

core/display/Container.js, line 184

Swaps the position of 2 Display Objects within this container.

Name Type Description
child PIXI.DisplayObject
child2 PIXI.DisplayObject

inherited toGlobal(position){PIXI.Point}

core/display/DisplayObject.js, line 402

Calculates the global position of the display object

Name Type Description
position PIXI.Point

The world origin to calculate from
Returns:
Type Description
PIXI.Point A point object representing the position of this object

inherited toLocal(position, from, point){PIXI.Point}

core/display/DisplayObject.js, line 430

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

Name Type Description
position PIXI.Point

The world origin to calculate from
from PIXI.DisplayObject optional

The DisplayObject to calculate the global position from
point PIXI.Point optional

A Point object in which to store the value, optional (otherwise will create a new Point)
Returns:
Type Description
PIXI.Point A point object representing the position of this object