Optional
_accessibleOptional
_accessibleReadonly
_anchor
Optional
_filters
Optional
filterOptional
_mask
Optional
_renderPrivate
_updateOptional
accessible
false
Optional
accessibleSetting to false will prevent any children inside this container to be accessible. Defaults to true.
true
Optional
accessibleSets the aria-label attribute of the shadow div
Optional
accessibleSpecify the pointer-events the accessible div will use Defaults to auto.
'auto'
Optional
accessibleSets the title attribute of the shadow div If accessibleTitle AND accessibleHint has not been this will default to 'container [tabIndex]'
Optional
accessibleSpecify the type of div the accessible layer is. Screen readers treat the element differently depending on this type. Defaults to button.
'button'
An optional bounds area for this container. Setting this rectangle will stop the renderer from recursively measuring the bounds of each children and instead use this single boundArea. This is great for optimisation! If for example you have a 1000 spinning particles and you know they all sit within a specific bounds, then setting it will mean the renderer will not need to measure the 1000 children to find the bounds. Instead it will just use the bounds you set.
Readonly
children
The array of children of this container.
Optional
cullIf 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.
scene.Container#
Optional
cullable
Should this object be rendered if the bounds of this object are out of frame?
Culling has no effect on whether updateTransform is called.
false
scene.Container#
Optional
cullableDetermines if the children to the container can be culled Setting this to false allows PixiJS to bypass a recursive culling function Which can help to optimize very complex scenes
true
scene.Container#
The cursor preferred when the mouse pointer is hovering over.
Readonly
destroy$
When Lifecycle Object is destroyed, it emits and closes this subject. Along with destroying his children, which in turn behave the same.
If the object has been destroyed via destroy(). If true, it should not be used.
Private
didPrivate
didOptional
effects
The mode of interaction for this object
Optional
filterReadonly
gameParent GameObject is assigned at creation.
Readonly
groupThe group transform is a transform relative to the render group it belongs too. If this container is render group then this will be an identity matrix. other wise it will be the same as the relativeGroupTransform. Use this value when actually rendering things to the screen
The hit-area specifies the area for which pointer events should be captured by this event target.
Private
includeWhether 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 Container has interactive 'static' or 'dynamic'
Private
isPrivate
isEach Lifecycle Object has label for pixi debugging.
Readonly
localCurrent transform of the object based on local factors: position, scale, other stuff.
Private
measurable
since 8.0.0
Container#label
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.
Readonly
relativeThe relative group transform is a transform relative to the render group it belongs too. It will include all parent transforms and up to the render group (think of it as kind of like a stage - but the stage can be nested). If this container is is self a render group matrix will be relative to its parent render group
Private
relativePrivate
renderReadonly
renderOptional
tab0
Private
uid
Readonly
update$
When Lifecycle Object is updated, it emits this subject. Along with updating his children, which in turn behave the same.
Static
prefixed
The opacity of the object.
The anchor sets the origin point of the sprite. The default value is taken from the 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.
import { Sprite } from 'pixi.js';
const sprite = new Sprite({texture: Texture.WHITE});
sprite.anchor.set(0.5); // This will set the origin to center. (0.5) is same as (0.5, 0.5).
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.
The blend mode to be applied to the sprite. Apply a value of
'normal' to reset the blend mode.
'normal'
The local bounds of the sprite.
The height of the sprite, setting this will actually modify the scale to achieve the value set.
Returns true if this container is a render group. This means that it will be rendered as a separate pass, with its own set of instructions
Whether or not the object should be rendered.
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).
4.0.0
The coordinate of the object relative to the local coordinates of the parent.
4.0.0
Can this object be rendered, if false the object will not be drawn but the transform will still be updated.
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.
Whether or not to round the x/y position of the sprite.
The scale factors of this object along the local coordinate axes.
The default scale is (1, 1).
4.0.0
The skew factor for the object in radians.
4.0.0
The bounds of the sprite, taking the texture's trim into account.
The texture that the sprite is using.
The tint applied to the sprite. This is a hex value.
A value of 0xFFFFFF will remove any tint effect.
0xFFFFFF
The visibility of the object. If false the object will not be drawn, and the transform will not be updated.
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.
The position of the container on the x axis relative to the local coordinates of the parent. An alias to position.x
The position of the container on the y axis relative to the local coordinates of the parent. An alias to position.y
Optional
options:
AddListenerOptions
Add a listener for a given event.
Add a one-time listener for a given event.
Optional
options:
RemoveListenerOptions
Remove the listeners of a given event.
Sets the size of the Sprite to the specified width and height. This is faster than setting the width and height separately.
This can be either a number or a [Size]Size object.
Optional
height:
number
The height to set. Defaults to the value of
width if not provided.
Static from
Helper function that creates a new sprite based on the source you provide. The source can be - frame id, image, video, canvas element, video element, texture
Source to create texture from
Optional
skipCache:
boolean
Whether to skip the cache or not
The newly created sprite
Static
mixin
Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set