Optionaltext: string | numberOptionalstyle: Partial<ITextStyle> | TextStyleThe style parameters
Optionalcanvas: ICanvasThe canvas element for drawing text
Optional_Optional_Protected_The anchor point defines the normalized coordinates in the texture that map to the position of this sprite.
By default, this is (0,0) (or texture.defaultAnchor
if you have modified that), which means the position
(x,y) of this Sprite will be the top-left corner.
Note: Updating texture.defaultAnchor after
constructing a Sprite does not update its anchor.
https://docs.cocos2d-x.org/cocos2d-x/en/sprites/manipulation.html
The bounds object, this is used to calculate and store the bounds of the displayObject.
Protected_Flags the cached bounds as dirty.
Protected_Cache of this display-object's bounds-rectangle.
Protected_Cached tint value so we can tell when the tint is changed. Value is used for 2d CanvasRenderer.
Protected_If the object has been destroyed via destroy(). If true, it should not be used.
Protected_Currently enabled filters.
Protected_The height of the sprite (this is initially set by the texture)
Protected_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.
Local bounds object, swapped with _bounds when using getLocalBounds().
Protected_Cache of this display-object's local-bounds rectangle.
Protected_The original, cached mask of the object.
The resolution / device pixel ratio of the canvas.
This is set to automatically match the renderer resolution by default, but can be overridden by setting manually.
Protected_Protected_The width of the sprite (this is initially set by the texture).
Protected_The zIndex of the displayObject. A higher value will mean it will be rendered on top of other displayObjects within the same container.
OptionalaccessibleOptionalaccessibleOptionalaccessibleOptionalaccessibleOptionalaccessibleOptionalaccessibleThe opacity of the object.
The blend mode to be applied to the sprite. Apply a value of PIXI.BLEND_MODES.NORMAL to reset the blend mode.
The canvas element that everything is drawn to.
ReadonlychildrenThe array of children of this container.
The canvas 2d context that everything is drawn with.
Should this object be rendered if the bounds of this object are out of frame?
Culling has no effect on whether updateTransform is called.
If set, this shape is used for culling instead of the bounds of this object. It can improve the culling performance of objects with many children. The culling area is defined in local space.
The cursor preferred when the mouse pointer is hovering over.
The mode of interaction for this object
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.
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'.
The hit-area specifies the area for which pointer events should be captured by this event target.
Whether this event target should fire UI events.
Whether this event target has any children that need UI events. This can be used optimize event propagation.
Returns true if the DisplayObject has interactive 'static' or 'dynamic'
Does any other displayObject use this object as a mask?
Used to fast check if a sprite is.. a sprite!
Handler for 'click' event
Handler for 'globalmousemove' event
Handler for 'globalpointermove' event
Handler for 'globaltouchmove' event
Handler for 'mousedown' event
Handler for 'mouseenter' event
Handler for 'mouseleave' event
Handler for 'mousemove' event
Handler for 'mouseout' event
Handler for 'mouseover' event
Handler for 'mouseup' event
Handler for 'mouseupoutside' event
Handler for 'pointercancel' event
Handler for 'pointerdown' event
Handler for 'pointerenter' event
Handler for 'pointerleave' event
Handler for 'pointermove' event
Handler for 'pointerout' event
Handler for 'pointerover' event
Handler for 'pointertap' event
Handler for 'pointerup' event
Handler for 'pointerupoutside' event
Handler for 'rightclick' event
Handler for 'rightdown' event
Handler for 'rightup' event
Handler for 'rightupoutside' event
Handler for 'tap' event
Handler for 'touchcancel' event
Handler for 'touchend' event
Handler for 'touchendoutside' event
Handler for 'touchmove' event
Handler for 'touchstart' event
Handler for 'wheel' event
The display object container that contains this display object.
Plugin that is responsible for rendering this element. Allows to customize the rendering process without overriding '_render' & '_renderCanvas' methods.
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.
OptionalrenderIf 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 PixiJS Layers
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.
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.
OptionaltabWorld 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.
ProtecteduvsThis is used to store the uvs data of the sprite, assigned at the same time as the vertexData in calculateVertices().
ProtectedvertexThis is used to store the vertex data of the sprite (basically a quad).
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.
ReadonlyworldThe multiplied alpha of the displayObject.
StaticdefaultOverride whether or not the resolution of the text is automatically adjusted to match the resolution of the renderer. Setting this to false can allow you to get crisper text at lower render resolutions.
StaticdefaultIf PIXI.Text.defaultAutoResolution is false, this will be the default resolution of the text. If not set it will default to PIXI.settings.RESOLUTION.
StaticdefaultSets the default value for the container property sortableChildren.
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 PixiJS Layers.
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.
StaticprefixedThe anchor sets the origin point of the sprite. The default value is taken from the 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.
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.
Readonly flag for destroyed display objects.
The height of the Text, setting this will actually modify the scale to achieve the value set.
The height of the sprite, setting this will actually modify the scale to achieve the value set.
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. Furthermore, a mask of an object must be in the subtree of its parent.
Otherwise, getLocalBounds may calculate incorrect bounds, which makes the container's width and height wrong.
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.
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.
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 PIXI.settings.ROUND_PIXELS.
Set the style of the text.
Set up an event listener to listen for changes on the style object and mark the text as dirty.
If setting the style can also be partial PIXI.ITextStyle.
Set the copy for the text object. To split a line you can use '\n'.
The texture that the sprite is using.
The width of the Text, setting this will actually modify the scale to achieve the value set.
The width of the sprite, setting this will actually modify the scale to achieve the value set.
Current transform of the object based on world (parent) factors.
Indicates if the object is globally visible.
The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
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.
StaticexperimentalOptionaloptions: boolean | IDestroyOptionsProtected_Calculates the bounds of the Text as a rectangle. The bounds calculation takes the worldTransform into account.
Protected_When the texture is updated, this event will fire to update the scale and frame.
Protected_Recursively updates transform of all objects from the root to this one internal function for toLocal()
Protected_Renders the object using the WebGL renderer
The renderer
Protected_ProtectedRenders this object and its children with culling.
The renderer
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown. If the child is already in this container, it will be moved to the specified index.
The child to add.
The absolute index where the child will be positioned at the end of the operation.
The child that was added.
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Optionaloptions: AddListenerOptionsRecalculates 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.
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.
Calculates worldTransform * vertices, store it in vertexData.
Tests if a point is inside this sprite
the point to test
The result of the test
Destroys this text object.
Note* Unlike a Sprite, a Text object will automatically destroy its baseTexture and texture as the majority of the time the texture will not be shared with any other Sprites.
Optionaloptions: boolean | IDestroyOptionsOptions parameter. A boolean will act as if all options have been set to that value
if set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.
Should it destroy the current texture of the sprite as well
Should it destroy the base texture of the sprite as well
Pair method for enableTempParent
Actual parent of element
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Used in Renderer, cacheAsBitmap and other places where you call an updateTransform on root.
const cacheParent = elem.enableTempParent();
elem.updateTransform();
elem.disableTempParent(cacheParent);
Return an array listing the events for which the emitter has registered listeners.
Calculates and returns the (world) bounds of the display object as a [Rectangle]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]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.
OptionalskipUpdate: booleanSetting 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.
Optionalrect: RectangleOptional rectangle to store the result of the bounds calculation.
Returns the child at the specified index
The index to get the child at
Optionaldeep: booleanReturns the index position of a child DisplayObject instance
The DisplayObject instance to identify
Optionalpoint: PointOptionalskipUpdate: booleanGets the local bounds of the text object.
Optionalrect: RectangleThe output rectangle.
The bounds.
Return the number of listeners listening to a given event.
ProtectedonOverridable method that can be used by Container subclasses whenever the children array is modified.
Optional_length: numberRemove all listeners, or those of the specified event.
Optionalevent: keyof DisplayObjectEventsRemoves a child from the specified index position.
The index to get the child from
The child that was removed.
Removes all children from this container that are within the begin and end indexes.
OptionalbeginIndex: numberThe beginning position.
OptionalendIndex: numberThe ending position. Default value is size of the container.
Removes the event listener in target's event listener list with the same type, callback, and options.
Removes the event listener in target's event listener list with the same type, callback, and options.
Optionaloptions: RemoveListenerOptionsRemove the DisplayObject from its parent Container. If the DisplayObject has no parent, do nothing.
Renders the object using the WebGL renderer.
The [_render]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 or if cullable is true and
the bounds of this object are out of frame, this implementation will entirely skip rendering.
See 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. See [cullable]PIXI.DisplayObject#cullable and [cullArea]PIXI.DisplayObject#cullArea. Other culling methods might be better suited for a large number static objects; see [@pixi-essentials/cull]https://www.npmjs.com/package/@pixi-essentials/cull and [pixi-cull]https://www.npmjs.com/package/pixi-cull.
The [renderAdvanced]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.
The renderer
ProtectedrenderRender the object using the WebGL renderer and advanced features.
The renderer
Changes the position of an existing child in the display object container
The child DisplayObject instance for which you want to change the index number
The resulting index number for the child display object
Set the parent Container of this DisplayObject.
The Container to add this DisplayObject to.
Convenience function to set the position, scale, skew and pivot at once.
Optionalx: numberThe X position
Optionaly: numberThe Y position
OptionalscaleX: numberThe X scale value
OptionalscaleY: numberThe Y scale value
Optionalrotation: numberThe rotation
OptionalskewX: numberThe X skew value
OptionalskewY: numberThe Y skew value
OptionalpivotX: numberThe X pivot value
OptionalpivotY: numberThe Y pivot value
Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.
Swaps the position of 2 Display Objects within this container.
First display object to swap
Second display object to swap
Calculates the global position of the display object.
The world origin to calculate from.
Optionalpoint: PA Point object in which to store the value, optional (otherwise will create a new Point).
OptionalskipUpdate: booleanShould we skip the update transform.
Calculates the local position of the display object relative to another point.
The world origin to calculate from.
Optionalfrom: DisplayObjectThe DisplayObject to calculate the global position from.
Optionalpoint: PA Point object in which to store the value, optional (otherwise will create a new Point).
OptionalskipUpdate: booleanShould we skip the update transform
Renders text to its canvas, and updates its texture.
By default this is used internally to ensure the texture is correct before rendering, but it can be used called externally, for example from this class to 'pre-generate' the texture from a piece of text, and then shared across multiple Sprites.
Whether to abort updating the text if the Text isn't dirty and the function is called.
Updates the transform on all children of this container for rendering.
StaticfromHelper 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
Source to create texture from
Optionaloptions: IBaseTextureOptions<any>See PIXI.BaseTexture's constructor for options.
The newly created sprite
StaticmixinMixes all enumerable properties and methods from a source object to DisplayObject.
The source of properties and methods to mix in.
The string that you would like the text to display