Class: ParticleContainer

PIXI.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 most advanced functionality will not work. ParticleContainer implements the basic object transform (position, scale, rotation) and some advanced functionality like tint (as of v4.5.6).

Other more advanced functionality like masking, children, filters, 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 = PIXI.Sprite.from("myImage.png");
    container.addChild(sprite);
}

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

new PIXI.ParticleContainer (maxSize, properties, batchSize, autoResize)

Name Type Attributes Default Description
maxSize number <optional>
1500

The maximum number of particles that can be rendered by the container. Affects size of allocated buffers.

properties object <optional>

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

properties.vertices boolean <optional>
false

When true, vertices be uploaded and applied. if sprite's scale/anchor/trim/frame/orig is dynamic, please set true.

properties.position boolean <optional>
true

When true, position be uploaded and applied.

properties.rotation boolean <optional>
false

When true, rotation be uploaded and applied.

properties.uvs boolean <optional>
false

When true, uvs be uploaded and applied.

properties.tint boolean <optional>
false

When true, alpha and tint be uploaded and applied.

batchSize number <optional>
16384

Number of particles per batch. If less than maxSize, it uses maxSize instead.

autoResize boolean <optional>
false

If true, container allocates more batches in case there are more than maxSize particles.

Extends

Members

autoResize boolean

If true, container allocates more batches in case there are more than maxSize particles.

Default Value:
  • false

baseTexture PIXI.BaseTexture

The texture used to render the children.

blendMode number

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:

interactiveChildren boolean overrides

roundPixels boolean

If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation. Advantages can include sharper image quality (like text) and faster rendering on canvas. The main disadvantage is movement of objects may appear less smooth. Default to true here as performance is usually the priority for particles.

Default Value:
  • true

tint number

The tint applied to the container. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

  • IMPORTANT: This is a WebGL only feature and will be ignored by the canvas renderer.
Default Value:
  • 0xFFFFFF

Methods

destroy (options) void overrides

Destroys the container

Name Type Attributes Default Description
options object | boolean <optional>

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

options.children boolean <optional>
false

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 boolean <optional>
false

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

options.baseTexture boolean <optional>
false

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

setProperties (properties) void

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 Properties

From class PIXI.Container

children Array<PIXI.DisplayObject> inherited

The array of children of this container.

height number inherited

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

sortableChildren boolean inherited

If set to true, the container will sort its children by zIndex value when updateTransform() is called, or manually if sortChildren() is called.

This actually changes the order of elements in the array, so should be treated as a basic solution that is not performant compared to other solutions, such as @link https://github.com/pixijs/pixi-display

Also be aware of that this may not work nicely with the addChildAt() function, as the zIndex sorting may cause the child to automatically sorted to another position.

See:

sortDirty boolean inherited

Should children be sorted by zIndex at the next updateTransform call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

width number inherited

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

From class PIXI.DisplayObject

_accessibleActive boolean inherited

TODO
  • Needs docs.

_accessibleDiv boolean inherited

TODO
  • Needs docs.

The bounds object, this is used to calculate and store the bounds of the displayObject.

_localBounds PIXI.Bounds inherited

Local bounds object, swapped with _bounds when using getLocalBounds().

accessible boolean inherited

Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set

accessibleChildren boolean inherited

Setting to false will prevent any children inside this container to be accessible. Defaults to true.

Default Value:
  • true

accessibleHint string inherited

Sets the aria-label attribute of the shadow div

accessiblePointerEvents string inherited

Specify the pointer-events the accessible div will use Defaults to auto.

Default Value:
  • 'auto'

accessibleTitle ?string inherited

Sets the title attribute of the shadow div If accessibleTitle AND accessibleHint has not been this will default to 'displayObject [tabIndex]'

accessibleType string inherited

Specify the type of div the accessible layer is. Screen readers treat the element differently depending on this type. Defaults to button.

Default Value:
  • 'button'

alpha number inherited

The opacity of the object.

angle number inherited

The angle of the object in degrees. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

buttonMode boolean inherited

If enabled, the mouse cursor use the pointer behavior when hovered over the displayObject if it is interactive Setting this changes the 'cursor' property to 'pointer'.

Example

 const sprite = new PIXI.Sprite(texture);
 sprite.interactive = true;
 sprite.buttonMode = true;

cacheAsBitmap boolean inherited

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.

cursor string inherited

This defines what cursor mode is used when the mouse cursor is hovered over the displayObject.

See:
Example

 const sprite = new PIXI.Sprite(texture);
 sprite.interactive = true;
 sprite.cursor = 'wait';

The area the filter is applied to. This is used as more of an optimization rather than figuring out the dimensions of the displayObject each frame you can set this rectangle.

Also works as an interaction mask.

filters Array<PIXI.Filter> inherited

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'.

Interaction shape. Children will be hit first, then this shape will be checked. Setting this will cause this shape to be checked in hit tests rather than the displayObject's bounds.

Example

 const sprite = new PIXI.Sprite(texture);
 sprite.interactive = true;
 sprite.hitArea = new PIXI.Rectangle(0, 0, 100, 100);

interactive boolean inherited

Enable interaction events for the DisplayObject. Touch, pointer and mouse events will not be emitted unless interactive is set to true.

Example

 const sprite = new PIXI.Sprite(texture);
 sprite.interactive = true;
 sprite.on('tap', (event) => {
    //handle event
 });

isMask boolean inherited

Does any other displayObject use this object as a mask?

isSprite boolean inherited

used to fast check if a sprite is.. a sprite!

localTransform PIXI.Matrix inherited

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

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 PixiJS a regular mask must be a PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it utilities shape clipping. To remove a mask, set this property to null.

For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.

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

 const graphics = new PIXI.Graphics();
 graphics.beginFill(0xFF3300);
 graphics.drawRect(50, 250, 100, 100);
 graphics.endFill();

 const sprite = new PIXI.Sprite(texture);
 sprite.mask = graphics;

name string inherited

The instance name of the object.

The display object container that contains this display object.

The center of rotation, scaling, and skewing for this display object in its local space. The position is the projection of pivot in the parent's local space.

By default, the pivot is the origin (0, 0).

Since:
  • PixiJS 4

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

Since:
  • PixiJS 4

renderable boolean inherited

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.

rotation number inherited

The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

Since:
  • PixiJS 4

The skew factor for the object in radians.

Since:
  • PixiJS 4

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.

visible boolean inherited

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.

worldAlpha number inherited

The multiplied alpha of the displayObject.

worldTransform PIXI.Matrix inherited

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

worldVisible boolean inherited

Indicates if the object is globally visible.

x number inherited

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

y number inherited

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

zIndex number inherited

The zIndex of the displayObject.

If a container has the sortableChildren property set to true, children will be automatically sorted by zIndex value; a higher value will mean it will be moved towards the end of the array, and thus rendered on top of other display objects within the same container.

See:
  • PIXI.Container#sortableChildren

_boundsID number protected inherited

Flags the cached bounds as dirty.

_boundsRect PIXI.Bounds protected inherited

Cache of this display-object's bounds-rectangle.

_destroyed boolean protected inherited

If the object has been destroyed via destroy(). If true, it should not be used.

_enabledFilters Array<PIXI.Filter> protected inherited

Currently enabled filters

_lastSortedIndex number protected inherited

Which index in the children array the display component was before the previous zIndex sort. Used by containers to help sort objects with the same zIndex, by using previous array index as the decider.

_localBoundsRect PIXI.Bounds protected inherited

Cache of this display-object's local-bounds rectangle.

_mask PIXI.Container | PIXI.MaskData | unknown protected inherited

The original, cached mask of the object.

_tempDisplayObjectParent PIXI.Container protected inherited

_zIndex number protected inherited

The zIndex of the displayObject. A higher value will mean it will be rendered on top of other displayObjects within the same container.

Inherited Methods

From class PIXI.Container

Adds one or more children to the container.

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

Name Type Description
children PIXI.DisplayObject

The DisplayObject(s) to add to the container

Returns:
Type Description
PIXI.DisplayObject The first child that was added.

addChildAt (child, index) PIXI.DisplayObject inherited

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.

calculateBounds () void inherited

Recalculates the bounds of the container.

This implementation will automatically fit the children's bounds into the calculation. Each child's bounds is limited to its mask's bounds or filterArea, if any is applied.

containerUpdateTransform inherited

Container default updateTransform, does update children of container. Will crash if there's no parent element.

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.

getChildByName (name, deep) PIXI.DisplayObject inherited

Returns the display object in the container.

Recursive searches are done in a preorder traversal.

Name Type Attributes Default Description
name string

Instance name.

deep boolean <optional>
false

Whether to search recursively

Returns:
Type Description
PIXI.DisplayObject The child with the specified name.

getChildIndex (child) number inherited

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

getLocalBounds (rect, skipChildrenUpdate) PIXI.Rectangle inherited

Retrieves the local bounds of the displayObject as a rectangle object.

Calling getLocalBounds may invalidate the _bounds of the whole subtree below. If using it inside a render() call, it is advised to call getBounds() immediately after to recalculate the world bounds of the subtree.

Name Type Attributes Default Description
rect PIXI.Rectangle <optional>

Optional rectangle to store the result of the bounds calculation.

skipChildrenUpdate boolean <optional>
false

Setting to true will stop re-calculation of children transforms, it was default behaviour of pixi 4.0-5.2 and caused many problems to users.

Returns:
Type Description
PIXI.Rectangle The rectangular bounding area.

removeChild (…children) PIXI.DisplayObject inherited

Removes one or more children from the container.

Name Type Description
children PIXI.DisplayObject

The DisplayObject(s) to remove

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

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.

removeChildren (beginIndex, endIndex) Array<PIXI.DisplayObject> inherited

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

Name Type Attributes Default Description
beginIndex number <optional>
0

The beginning position.

endIndex number <optional>
this.children.length

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

Returns:
Type Description
Array<PIXI.DisplayObject> List of removed children

renderWebGL (renderer) void Deprecated`` : since 5.0.0 inherited

Name Type Description
renderer PIXI.Renderer

Instance of renderer

See:
  • PIXI.Container#render

setChildIndex (child, index) void inherited

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

sortChildren () void inherited

Sorts children by zIndex. Previous order is mantained for 2 children with the same zIndex.

swapChildren (child, child2) void inherited

Swaps the position of 2 Display Objects within this container.

Name Type Description
child PIXI.DisplayObject

First display object to swap

child2 PIXI.DisplayObject

Second display object to swap

_calculateBounds () void protected inherited

Recalculates the content bounds of this object. This should be overriden to calculate the bounds of this specific object (not including children).

_render (renderer) void protected inherited

To be overridden by the subclasses.

Name Type Description
renderer PIXI.Renderer

The renderer

_renderCanvas (renderer) void protected inherited

To be overridden by the subclass

Name Type Description
renderer PIXI.CanvasRenderer

The renderer

renderAdvanced (renderer) void protected inherited

Render the object using the WebGL renderer and advanced features.

Name Type Description
renderer PIXI.Renderer

The renderer

From class PIXI.DisplayObject

_recursivePostUpdateTransform () void inherited

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

disableTempParent (cacheParent) void inherited

Pair method for enableTempParent

Name Type Description
cacheParent PIXI.DisplayObject

Actual parent of element

displayObjectUpdateTransform inherited

DisplayObject default updateTransform, does not update children of container. Will crash if there's no parent element.

Used in Renderer, cacheAsBitmap and other places where you call an updateTransform on root

const cacheParent = elem.enableTempParent();
elem.updateTransform();
elem.disableTempParent(cacheParent);
Returns:
Type Description
PIXI.DisplayObject current parent

getBounds (skipUpdate, rect) PIXI.Rectangle inherited

Calculates and returns the (world) bounds of the display object as a Rectangle.

This method is expensive on containers with a large subtree (like the stage). This is because the bounds of a container depend on its children's bounds, which recursively causes all bounds in the subtree to be recalculated. The upside, however, is that calling getBounds once on a container will indeed update the bounds of all children (the whole subtree, in fact). This side effect should be exploited by using displayObject._bounds.getRectangle() when traversing through all the bounds in a scene graph. Otherwise, calling getBounds on each object in a subtree will cause the total cost to increase quadratically as its height increases.

  • The transforms of all objects in a container's subtree and of all ancestors are updated.
  • The world bounds of all display objects in a container's subtree will also be recalculated.

The _bounds object stores the last calculation of the bounds. You can use to entirely skip bounds calculation if needed.

const lastCalculatedBounds = displayObject._bounds.getRectangle(optionalRect);

Do know that usage of getLocalBounds can corrupt the _bounds of children (the whole subtree, actually). This is a known issue that has not been solved. See getLocalBounds for more details.

getBounds should be called with skipUpdate equal to true in a render() call. This is because the transforms are guaranteed to be update-to-date. In fact, recalculating inside a render() call may cause corruption in certain cases.

Name Type Attributes Description
skipUpdate boolean <optional>

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 PIXI.Rectangle <optional>

Optional rectangle to store the result of the bounds calculation.

Returns:
Type Description
PIXI.Rectangle The minimum axis-aligned rectangle in world space that fits around this object.

getGlobalPosition (point, skipUpdate) PIXI.Point inherited

Returns the global position of the displayObject. Does not depend on object scale, rotation and pivot.

Name Type Attributes Default Description
point PIXI.Point <optional>
new PIXI.Point()

The point to write the global value to.

skipUpdate boolean <optional>
false

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.

Returns:
Type Description
PIXI.Point The updated point.

Set the parent Container of this DisplayObject.

Name Type Description
container PIXI.Container

The Container to add this DisplayObject to.

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

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

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

Name Type Attributes Default Description
x number <optional>
0

The X position

y number <optional>
0

The Y position

scaleX number <optional>
1

The X scale value

scaleY number <optional>
1

The Y scale value

rotation number <optional>
0

The rotation

skewX number <optional>
0

The X skew value

skewY number <optional>
0

The Y skew value

pivotX number <optional>
0

The X pivot value

pivotY number <optional>
0

The Y pivot value

Returns:
Type Description
PIXI.DisplayObject The DisplayObject instance

toGlobal (position, point, skipUpdate) PIXI.Point inherited

Calculates the global position of the display object.

Name Type Attributes Default Description
position PIXI.IPointData

The world origin to calculate from.

point PIXI.Point <optional>

A Point object in which to store the value, optional (otherwise will create a new Point).

skipUpdate boolean <optional>
false

Should we skip the update transform.

Returns:
Type Description
PIXI.Point A point object representing the position of this object.

toLocal (position, from, point, skipUpdate) PIXI.Point inherited

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

Name Type Attributes Default Description
position PIXI.IPointData

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).

skipUpdate boolean <optional>
false

Should we skip the update transform

Returns:
Type Description
PIXI.Point A point object representing the position of this object

Inherited Events

From class PIXI.Container

Fired when a DisplayObject is added to this Container.

Name Type Description
child PIXI.DisplayObject

The child added to the Container.

container PIXI.Container

The container that added the child.

index number

The children's index of the added child.

From class PIXI.DisplayObject

Fired when a pointer device button (usually a mouse left-button) is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a pointer device button (usually a mouse left-button) is pressed on the display. object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a pointer device (usually a mouse) is moved while over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a pointer device (usually a mouse) is moved off the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a pointer device (usually a mouse) is moved onto the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a pointer device button (usually a mouse left-button) is released over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a pointer device button (usually a mouse left-button) is released outside the display object that initially registered a mousedown. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when the operating system cancels a pointer event. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a pointer device button is pressed on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a pointer device is moved while over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a pointer device is moved off the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a pointer device is moved onto the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a pointer device button is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a pointer device button is released over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a pointer device button is released outside the display object that initially registered a pointerdown. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a DisplayObject is removed from this Container.

Name Type Description
child PIXI.DisplayObject

The child removed from the Container.

container PIXI.Container

The container that removed removed the child.

index number

The former children's index of the removed child

Fired when a pointer device secondary button (usually a mouse right-button) is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a pointer device secondary button (usually a mouse right-button) is pressed on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a pointer device secondary button (usually a mouse right-button) is released over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a pointer device secondary button (usually a mouse right-button) is released outside the display object that initially registered a rightdown. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a touch point is placed and removed from the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when the operating system cancels a touch. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a touch point is removed from the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a touch point is removed outside of the display object that initially registered a touchstart. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a touch point is moved along the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when a touch point is placed on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.InteractionEvent

Interaction event

Fired when this DisplayObject is added to a Container.

Name Type Description
container PIXI.Container

The container added to.

Fired when this DisplayObject is removed from a Container.

Name Type Description
container PIXI.Container

The container removed from.