Options
All
  • Public
  • Public/Protected
  • All
Menu

An individual particle image. You shouldn't have to deal with these.

Hierarchy

  • Sprite
    • Particle

Implements

Index

Constructors

Properties

_anchor: ObservablePoint<any>
_bounds: Bounds
_boundsID: number
_boundsRect: Rectangle
_cachedTint: number
_destroyed: boolean
_enabledFilters: Filter[]
_height: number
_lastSortedIndex: number
_localBounds: Bounds
_localBoundsRect: Rectangle
_mask: Container | MaskData
_texture: Texture<Resource>
_textureID: number
_textureTrimmedID: number
_tintRGB: number
_width: number
_zIndex: number
age: number

The current age of the particle, in seconds.

agePercent: number

The current age of the particle as a normalized value between 0 and 1.

alpha: number
blendMode: BLEND_MODES
children: DisplayObject[]
config: {}

Static per-particle configuration for behaviors to use. Is not cleared when recycling.

Type declaration

  • [key: string]: any
containerUpdateTransform: () => void

Type declaration

    • (): void
    • Returns void

displayObjectUpdateTransform: () => void

Type declaration

    • (): void
    • Returns void

emitter: Emitter

The emitter that controls this particle.

filterArea: Rectangle
filters: Filter[]
indices: Uint16Array
isMask: boolean
isSprite: boolean
maxLife: number

The maximum lifetime of this particle, in seconds.

next: Particle

Reference to the next particle in the list.

nextChild: LinkedListChild
oneOverLife: number

One divided by the max life of the particle, saved for slightly faster math.

parent: Container
pluginName: string
prev: Particle

Reference to the previous particle in the list.

prevChild: LinkedListChild
renderable: boolean
sortDirty: boolean
sortableChildren: boolean
transform: Transform
uvs: Float32Array
vertexData: Float32Array
visible: boolean
worldAlpha: number
prefixed: string | boolean

Accessors

  • get _tempDisplayObjectParent(): TemporaryDisplayObject
  • member

    {PIXI.Container}

    Returns TemporaryDisplayObject

  • get anchor(): ObservablePoint<any>
  • set anchor(value: ObservablePoint<any>): void
  • The anchor sets the origin point of the sprite. The default value is taken from the {@link PIXI.Texture|Texture} and passed to the constructor.

    The default is (0,0), this means the sprite's origin is the top left.

    Setting the anchor to (0.5,0.5) means the sprite's origin is centered.

    Setting the anchor to (1,1) would mean the sprite's origin point will be the bottom right corner.

    If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

    example

    const sprite = new PIXI.Sprite(texture); sprite.anchor.set(0.5); // This will set the origin to center. (0.5) is same as (0.5, 0.5).

    member

    {PIXI.ObservablePoint}

    Returns ObservablePoint<any>

  • The anchor sets the origin point of the sprite. The default value is taken from the {@link PIXI.Texture|Texture} and passed to the constructor.

    The default is (0,0), this means the sprite's origin is the top left.

    Setting the anchor to (0.5,0.5) means the sprite's origin is centered.

    Setting the anchor to (1,1) would mean the sprite's origin point will be the bottom right corner.

    If you pass only single parameter, it will set both x and y to the same value as shown in the example below.

    example

    const sprite = new PIXI.Sprite(texture); sprite.anchor.set(0.5); // This will set the origin to center. (0.5) is same as (0.5, 0.5).

    member

    {PIXI.ObservablePoint}

    Parameters

    • value: ObservablePoint<any>

    Returns void

  • get angle(): number
  • set angle(value: number): void
  • 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.

    member

    {number}

    Returns number

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

    member

    {number}

    Parameters

    • value: number

    Returns void

  • get height(): number
  • set height(value: number): void
  • The height of the sprite, setting this will actually modify the scale to achieve the value set

    member

    {number}

    Returns number

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

    member

    {number}

    Parameters

    • value: number

    Returns void

  • get localTransform(): Matrix
  • Current transform of the object based on local factors: position, scale, other stuff.

    member

    {PIXI.Matrix}

    readonly

    Returns Matrix

  • get mask(): Container | MaskData
  • set mask(value: Container | MaskData): void
  • 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 {@link PIXI.Graphics} or a {@link 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.

    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;

    todo

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

    member

    {PIXI.Container|PIXI.MaskData|null}

    Returns Container | MaskData

  • 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 {@link PIXI.Graphics} or a {@link 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.

    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;

    todo

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

    member

    {PIXI.Container|PIXI.MaskData|null}

    Parameters

    • value: Container | MaskData

    Returns void

  • get pivot(): ObservablePoint<any>
  • set pivot(value: ObservablePoint<any>): void
  • 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

    member

    {PIXI.ObservablePoint}

    Returns ObservablePoint<any>

  • 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

    member

    {PIXI.ObservablePoint}

    Parameters

    • value: ObservablePoint<any>

    Returns void

  • get position(): ObservablePoint<any>
  • set position(value: ObservablePoint<any>): void
  • The coordinate of the object relative to the local coordinates of the parent.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    Returns ObservablePoint<any>

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

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    Parameters

    • value: ObservablePoint<any>

    Returns void

  • get rotation(): number
  • set rotation(value: number): void
  • 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.

    member

    {number}

    Returns number

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

    member

    {number}

    Parameters

    • value: number

    Returns void

  • get roundPixels(): boolean
  • set roundPixels(value: boolean): void
  • 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. To set the global default, change {@link PIXI.settings.ROUND_PIXELS}

    member

    {boolean}

    default

    false

    Returns 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. To set the global default, change {@link PIXI.settings.ROUND_PIXELS}

    member

    {boolean}

    default

    false

    Parameters

    • value: boolean

    Returns void

  • get scale(): ObservablePoint<any>
  • set scale(value: ObservablePoint<any>): void
  • The scale factors of this object along the local coordinate axes.

    The default scale is (1, 1).

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    Returns ObservablePoint<any>

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

    The default scale is (1, 1).

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    Parameters

    • value: ObservablePoint<any>

    Returns void

  • get skew(): ObservablePoint<any>
  • set skew(value: ObservablePoint<any>): void
  • The skew factor for the object in radians.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    Returns ObservablePoint<any>

  • The skew factor for the object in radians.

    since

    PixiJS 4

    member

    {PIXI.ObservablePoint}

    Parameters

    • value: ObservablePoint<any>

    Returns void

  • get texture(): Texture<Resource>
  • set texture(value: Texture<Resource>): void
  • The texture that the sprite is using

    member

    {PIXI.Texture}

    Returns Texture<Resource>

  • The texture that the sprite is using

    member

    {PIXI.Texture}

    Parameters

    • value: Texture<Resource>

    Returns void

  • get tint(): number
  • set tint(value: number): void
  • The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

    member

    {number}

    default

    0xFFFFFF

    Returns number

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

    member

    {number}

    default

    0xFFFFFF

    Parameters

    • value: number

    Returns void

  • get width(): number
  • set width(value: number): void
  • The width of the sprite, setting this will actually modify the scale to achieve the value set

    member

    {number}

    Returns number

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

    member

    {number}

    Parameters

    • value: number

    Returns void

  • get worldTransform(): Matrix
  • Current transform of the object based on world (parent) factors.

    member

    {PIXI.Matrix}

    readonly

    Returns Matrix

  • get worldVisible(): boolean
  • Indicates if the object is globally visible.

    member

    {boolean}

    readonly

    Returns boolean

  • get x(): number
  • set x(value: number): void
  • The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x

    member

    {number}

    Returns number

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

    member

    {number}

    Parameters

    • value: number

    Returns void

  • get y(): number
  • set y(value: number): void
  • The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y

    member

    {number}

    Returns number

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

    member

    {number}

    Parameters

    • value: number

    Returns void

  • get zIndex(): number
  • set zIndex(value: number): void
  • 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.

    member

    {number}

    see

    PIXI.Container#sortableChildren

    Returns number

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

    member

    {number}

    see

    PIXI.Container#sortableChildren

    Parameters

    • value: number

    Returns void

Methods

  • _calculateBounds(): void
  • Updates the bounds of the sprite.

    Returns void

  • _onTextureUpdate(): void
  • When the texture is updated, this event will fire to update the scale and frame

    Returns void

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

    Returns void

  • _render(renderer: Renderer): void
  • Renders the object using the WebGL renderer

    Parameters

    • renderer: Renderer

      The webgl renderer to use.

    Returns void

  • addChild<T>(...children: T): T[0]
  • Adds one or more children to the container.

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

    Type parameters

    • T: DisplayObject[]

    Parameters

    • Rest ...children: T

      The DisplayObject(s) to add to the container

    Returns T[0]

    The first child that was added.

  • addChildAt<T>(child: T, index: number): T
  • Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

    Type parameters

    • T: DisplayObject<T>

    Parameters

    • child: T

      The child to add

    • index: number

      The index to place the child in

    Returns T

    The child that was added.

  • addListener(event: string | symbol, fn: ListenerFn, context?: any): Particle
  • Parameters

    • event: string | symbol
    • fn: ListenerFn
    • Optional context: any

    Returns Particle

  • calculateBounds(): void
  • 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.

    Returns void

  • calculateTrimmedVertices(): void
  • calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData This is used to ensure that the true width and height of a trimmed texture is respected

    Returns void

  • calculateVertices(): void
  • calculates worldTransform * vertices, store it in vertexData

    Returns void

  • containsPoint(point: IPointData): boolean
  • Tests if a point is inside this sprite

    Parameters

    • point: IPointData

      the point to test

    Returns boolean

    the result of the test

  • destroy(): void
  • disableTempParent(cacheParent: DisplayObject): void
  • Pair method for enableTempParent

    Parameters

    • cacheParent: DisplayObject

      Actual parent of element

    Returns void

  • emit(event: string | symbol, ...args: any[]): boolean
  • Calls each of the listeners registered for a given event.

    Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

  • enableTempParent(): DisplayObject
  • Used in Renderer, cacheAsBitmap and other places where you call an updateTransform on root

    const cacheParent = elem.enableTempParent();
    elem.updateTransform();
    elem.disableTempParent(cacheParent);

    Returns DisplayObject

    current parent

  • eventNames(): (string | symbol)[]
  • Return an array listing the events for which the emitter has registered listeners.

    Returns (string | symbol)[]

  • getBounds(skipUpdate?: boolean, rect?: Rectangle): Rectangle
  • Calculates and returns the (world) bounds of the display object as a [Rectangle]{@link PIXI.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]{@link PIXI.DisplayObject#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.

    Parameters

    • Optional skipUpdate: boolean
    • Optional rect: Rectangle

    Returns Rectangle

    The minimum axis-aligned rectangle in world space that fits around this object.

  • getChildAt(index: number): DisplayObject
  • Returns the child at the specified index

    Parameters

    • index: number

      The index to get the child at

    Returns DisplayObject

    The child at the given index, if any.

  • getChildIndex(child: DisplayObject): number
  • Returns the index position of a child DisplayObject instance

    Parameters

    • child: DisplayObject

      The DisplayObject instance to identify

    Returns number

    The index position of the child display object to identify

  • getLocalBounds(rect?: Rectangle): Rectangle
  • Gets the local bounds of the sprite object.

    Parameters

    • Optional rect: Rectangle

    Returns Rectangle

    The bounds.

  • init(maxLife: number): void
  • Initializes the particle for use, based on the properties that have to have been set already on the particle.

    Parameters

    • maxLife: number

    Returns void

  • kill(): void
  • Kills the particle, removing it from the display list and telling the emitter to recycle it.

    Returns void

  • listenerCount(event: string | symbol): number
  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

  • listeners(event: string | symbol): ListenerFn[]
  • Return the listeners registered for a given event.

    Parameters

    • event: string | symbol

    Returns ListenerFn[]

  • off(event: string | symbol, fn?: ListenerFn, context?: any, once?: boolean): Particle
  • Parameters

    • event: string | symbol
    • Optional fn: ListenerFn
    • Optional context: any
    • Optional once: boolean

    Returns Particle

  • on(event: string | symbol, fn: ListenerFn, context?: any): Particle
  • Add a listener for a given event.

    Parameters

    • event: string | symbol
    • fn: ListenerFn
    • Optional context: any

    Returns Particle

  • onChildrenChange(_length?: number): void
  • Overridable method that can be used by Container subclasses whenever the children array is modified

    Parameters

    • Optional _length: number

    Returns void

  • once(event: string | symbol, fn: ListenerFn, context?: any): Particle
  • Add a one-time listener for a given event.

    Parameters

    • event: string | symbol
    • fn: ListenerFn
    • Optional context: any

    Returns Particle

  • removeAllListeners(event?: string | symbol): Particle
  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: string | symbol

    Returns Particle

  • removeChild<T>(...children: T): T[0]
  • Removes one or more children from the container.

    Type parameters

    • T: DisplayObject[]

    Parameters

    • Rest ...children: T

      The DisplayObject(s) to remove

    Returns T[0]

    The first child that was removed.

  • removeChildAt(index: number): DisplayObject
  • Removes a child from the specified index position.

    Parameters

    • index: number

      The index to get the child from

    Returns DisplayObject

    The child that was removed.

  • removeChildren(beginIndex?: number, endIndex?: number): DisplayObject[]
  • Removes all children from this container that are within the begin and end indexes.

    Parameters

    • Optional beginIndex: number
    • Optional endIndex: number

    Returns DisplayObject[]

    List of removed children

  • removeListener(event: string | symbol, fn?: ListenerFn, context?: any, once?: boolean): Particle
  • Remove the listeners of a given event.

    Parameters

    • event: string | symbol
    • Optional fn: ListenerFn
    • Optional context: any
    • Optional once: boolean

    Returns Particle

  • render(renderer: Renderer): void
  • Renders the object using the WebGL renderer.

    The [_render]{@link PIXI.Container#_render} method is be overriden for rendering the contents of the container itself. This render method will invoke it, and also invoke the render methods of all children afterward.

    If renderable or visible is false or if worldAlpha is not positive, this implementation will entirely skip rendering. See {@link PIXI.DisplayObject} for choosing between renderable or visible. Generally, setting alpha to zero is not recommended for purely skipping rendering.

    When your scene becomes large (especially when it is larger than can be viewed in a single screen), it is advised to employ culling to automatically skip rendering objects outside of the current screen. The @pixi-essentials/cull and pixi-cull packages do this out of the box.

    The [renderAdvanced]{@link PIXI.Container#renderAdvanced} method is internally used when when masking or filtering is applied on a container. This does, however, break batching and can affect performance when masking and filtering is applied extensively throughout the scene graph.

    Parameters

    • renderer: Renderer

      The renderer

    Returns void

  • renderAdvanced(renderer: Renderer): void
  • Render the object using the WebGL renderer and advanced features.

    Parameters

    • renderer: Renderer

      The renderer

    Returns void

  • setChildIndex(child: DisplayObject, index: number): void
  • Changes the position of an existing child in the display object container

    Parameters

    • child: 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

    Returns void

  • setParent(container: Container): Container
  • Set the parent Container of this DisplayObject.

    Parameters

    • container: Container

      The Container to add this DisplayObject to.

    Returns Container

    The Container that this DisplayObject was added to.

  • setTransform(x?: number, y?: number, scaleX?: number, scaleY?: number, rotation?: number, skewX?: number, skewY?: number, pivotX?: number, pivotY?: number): Particle
  • Convenience function to set the position, scale, skew and pivot at once.

    Parameters

    • Optional x: number
    • Optional y: number
    • Optional scaleX: number
    • Optional scaleY: number
    • Optional rotation: number
    • Optional skewX: number
    • Optional skewY: number
    • Optional pivotX: number
    • Optional pivotY: number

    Returns Particle

    The DisplayObject instance

  • sortChildren(): void
  • Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.

    Returns void

  • swapChildren(child: DisplayObject, child2: DisplayObject): void
  • Swaps the position of 2 Display Objects within this container.

    Parameters

    • child: DisplayObject

      First display object to swap

    • child2: DisplayObject

      Second display object to swap

    Returns void

  • toGlobal<P>(position: IPointData, point?: P, skipUpdate?: boolean): P
  • Calculates the global position of the display object.

    Type parameters

    • P: IPointData = Point

    Parameters

    • position: IPointData

      The world origin to calculate from.

    • Optional point: P
    • Optional skipUpdate: boolean

    Returns P

    A point object representing the position of this object.

  • toLocal<P>(position: IPointData, from?: DisplayObject, point?: P, skipUpdate?: boolean): P
  • Calculates the local position of the display object relative to another point.

    Type parameters

    • P: IPointData = Point

    Parameters

    • position: IPointData

      The world origin to calculate from.

    • Optional from: DisplayObject
    • Optional point: P
    • Optional skipUpdate: boolean

    Returns P

    A point object representing the position of this object

  • updateTransform(): void
  • Updates the transform on all children of this container for rendering

    Returns void

  • from(source: SpriteSource, options?: IBaseTextureOptions<any>): Sprite
  • Helper function that creates a new sprite based on the source you provide. The source can be - frame id, image url, video url, canvas element, video element, base texture

    static

    Parameters

    • source: SpriteSource

      Source to create texture from

    • Optional options: IBaseTextureOptions<any>

    Returns Sprite

    The newly created sprite

  • mixin(source: Dict<any>): void
  • Mixes all enumerable properties and methods from a source object to DisplayObject.

    Parameters

    • source: Dict<any>

      The source of properties and methods to mix in.

    Returns void

Generated using TypeDoc