Optional geometry: GraphicsGeometryGeometry to use, if omitted will create a new GraphicsGeometry instance.
Optional _accessibleOptional _accessibleThe bounds object, this is used to calculate and store the bounds of the displayObject.
Local bounds object, swapped with _bounds when using getLocalBounds().
Optional accessibleOptional accessibleOptional accessibleOptional accessibleOptional accessibleOptional accessibleThe opacity of the object.
Readonly childrenThe array of children of this container.
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.
Should this object be rendered if the bounds of this object are out of frame?
Culling has no effect on whether updateTransform is called.
Readonly currentCurrent path
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.
Renderer plugin for batching
Optional renderCan 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.
Represents the vertex and fragment shaders that processes the geometry and runs on the GPU. Can be shared between multiple Graphics objects.
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.
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.
PIXI.Container.defaultSortableChildren
Optional tabWorld 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.
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.
Readonly worldThe multiplied alpha of the displayObject.
Static Readonly curvesGraphics curves resolution settings. If adaptive flag is set to true,
the resolution is calculated based on the curve's length to ensure better visual quality.
Adaptive draw works with bezierCurveTo and quadraticCurveTo.
Static defaultSets 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.
Static prefixedThe 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 graphic shape. Apply a value of
PIXI.BLEND_MODES.NORMAL to reset the blend mode. Note that, since each
primitive in the GraphicsGeometry list is rendered sequentially, modes
such as PIXI.BLEND_MODES.ADD and PIXI.BLEND_MODES.MULTIPLY will
be applied per-primitive.
PIXI.BLEND_MODES.NORMAL
Readonly flag for destroyed display objects.
Includes vertex positions, face indices, normals, colors, UVs, and custom attributes within buffers, reducing the cost of passing all this data to the GPU. Can be shared between multiple Mesh or Graphics objects.
The height of the Container, setting this will actually modify the scale to achieve the value set.
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.
import { Graphics, Sprite } from 'pixi.js';
const graphics = new Graphics();
graphics.beginFill(0xFF3300);
graphics.drawRect(50, 250, 100, 100);
graphics.endFill();
const sprite = new Sprite(texture);
sprite.mask = graphics;
At the moment, CanvasRenderer doesn't support Sprite as mask.
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
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).
4.0.0
The skew factor for the object in radians.
4.0.0
The tint applied to each graphic shape. This is a hex value. A value of 0xFFFFFF will remove any tint effect.
0xFFFFFF
The width of the Container, setting this will actually modify the scale to achieve the value set.
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.
PIXI.Container#sortableChildren
Optional options: boolean | IDestroyOptionsAdds one or more children to the container.
Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)
Rest ...children: UThe DisplayObject(s) to add to the container
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.
Optional options: AddListenerOptionsOptional options: AddListenerOptionsRest ...args: ArgumentMap<DisplayObjectEvents>[Extract<T, keyof DisplayObjectEvents>]Optional context: anyThe arc method creates an arc/curve (used to create circles, or parts of circles).
The x-coordinate of the center of the circle
The y-coordinate of the center of the circle
The radius of the circle
The starting angle, in radians (0 is at the 3 o'clock position of the arc's circle)
The ending angle, in radians
Optional anticlockwise: booleanSpecifies whether the drawing should be counter-clockwise or clockwise. False is default, and indicates clockwise, while true indicates counter-clockwise.
The arcTo method creates an arc/curve between two tangents on the canvas.
The first tangent is from the start point to the first control point,
and the second tangent is from the first control point to the second control point.
Note that the second control point is not necessarily the end point of the arc.
"borrowed" from https://code.google.com/p/fxcanvas/ - thanks google!
The x-coordinate of the first control point of the arc
The y-coordinate of the first control point of the arc
The x-coordinate of the second control point of the arc
The y-coordinate of the second control point of the arc
The radius of the arc
Specifies a simple one-color fill that subsequent calls to other Graphics methods (such as lineTo() or drawCircle()) use when drawing.
Optional color: ColorSourcethe color of the fill
Optional alpha: numberthe alpha of the fill, will override the color's alpha
Begin adding holes to the last draw shape
IMPORTANT: holes must be fully inside a shape to work
Also weirdness ensues if holes overlap!
Ellipses, Circles, Rectangles and Rounded Rectangles cannot be holes or host for holes in CanvasRenderer,
please use moveTo lineTo, quadraticCurveTo if you rely on pixi-legacy bundle.
Begin the texture fill. Note: The wrap mode of the texture is forced to REPEAT on render.
Optional options: IFillStyleOptionsFill style object.
This Graphics object. Good for chaining method calls
Calculate the points for a bezier curve and then draws it.
Control point x
Control point y
Second Control point x
Second Control point y
Destination point x
Destination point y
This Graphics object. Good for chaining method calls
Tests if a point is inside this graphics object
the point to test
Destroys the Graphics object.
Optional options: boolean | IDestroyOptionsOptions parameter. A boolean will act as if all options have been set to that value
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.
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.
Draws an ellipse.
The X coordinate of the center of the ellipse
The Y coordinate of the center of the ellipse
The half width of the ellipse
The half height of the ellipse
Rest ...path: number[] | IPointData[]Draws a rectangle shape.
The X coord of the top-left of the rectangle
The Y coord of the top-left of the rectangle
The width of the rectangle
The height of the rectangle
Draw a rectangle shape with rounded/beveled corners.
The X coord of the top-left of the rectangle
The Y coord of the top-left of the rectangle
The width of the rectangle
The height of the rectangle
Radius of the rectangle corners
Draw any shape.
Shape to draw
Calls each of the listeners registered for a given event.
Rest ...args: ArgumentMap<DisplayObjectEvents>[Extract<T, keyof DisplayObjectEvents>]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.
Optional skipUpdate: 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.
Optional rect: RectangleOptional rectangle to store the result of the bounds calculation.
Returns the child at the specified index
The index to get the child at
Optional deep: booleanReturns the index position of a child DisplayObject instance
The DisplayObject instance to identify
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.
Optional rect: RectangleOptional rectangle to store the result of the bounds calculation.
Optional skipChildrenUpdate: booleanSetting 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.
Specifies the line style used for subsequent calls to Graphics methods such as the lineTo() method or the drawCircle() method.
Optional width: numberwidth of the line to draw, will update the objects stored style
Optional color: ColorSourcecolor of the line to draw, will update the objects stored style
Optional alpha: numberalpha of the line to draw, will update the objects stored style
Optional alignment: numberalignment of the line to draw, (0 = inner, 0.5 = middle, 1 = outer). WebGL only.
Optional native: booleanIf true the lines will be draw using LINES instead of TRIANGLE_STRIP
Specifies the line style used for subsequent calls to Graphics methods such as the lineTo() method or the drawCircle() method.
Optional options: ILineStyleOptionsLine style options
This Graphics object. Good for chaining method calls
Like line style but support texture for line fill.
Optional options: ILineStyleOptionsCollection of options for setting line style.
This Graphics object. Good for chaining method calls
Draws a line using the current line style from the current drawing position to (x, y); The current drawing position is then set to (x, y).
the X coordinate to draw to
the Y coordinate to draw to
Return the number of listeners listening to a given event.
Return the listeners registered for a given event.
Optional fn: ((...args) => void)Rest ...args: ArgumentMap<DisplayObjectEvents>[Extract<T, keyof DisplayObjectEvents>]Optional context: anyOptional once: booleanAdd a listener for a given event.
Rest ...args: ArgumentMap<DisplayObjectEvents>[Extract<T, keyof DisplayObjectEvents>]Optional context: anyAdd a one-time listener for a given event.
Rest ...args: ArgumentMap<DisplayObjectEvents>[Extract<T, keyof DisplayObjectEvents>]Optional context: anyCalculate the points for a quadratic bezier curve and then draws it. Based on: https://stackoverflow.com/questions/785097/how-do-i-implement-a-bezier-curve-in-c
Control point x
Control point y
Destination point x
Destination point y
Removes one or more children from the container.
Rest ...children: UThe DisplayObject(s) to remove
The first child that was removed.
Removes 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.
Optional beginIndex: numberThe beginning position.
Optional endIndex: numberThe ending position. Default value is size of the container.
Optional options: RemoveListenerOptionsOptional options: RemoveListenerOptionsRemove the listeners of a given event.
Optional fn: ((...args) => void)Rest ...args: ArgumentMap<DisplayObjectEvents>[Extract<T, keyof DisplayObjectEvents>]Optional context: anyOptional once: booleanRenders 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
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
Apply a matrix to the positional data.
Matrix to use for transform current shape.
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.
Optional x: numberThe X position
Optional y: numberThe Y position
Optional scaleX: numberThe X scale value
Optional scaleY: numberThe Y scale value
Optional rotation: numberThe rotation
Optional skewX: numberThe X skew value
Optional skewY: numberThe Y skew value
Optional pivotX: numberThe X pivot value
Optional pivotY: numberThe Y pivot value
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.
Optional point: PA Point object in which to store the value, optional (otherwise will create a new Point).
Optional skipUpdate: booleanShould we skip the update transform.
Calculates the local position of the display object relative to another point.
The world origin to calculate from.
Optional from: DisplayObjectThe DisplayObject to calculate the global position from.
Optional point: PA Point object in which to store the value, optional (otherwise will create a new Point).
Optional skipUpdate: booleanShould we skip the update transform
Static mixinMixes all enumerable properties and methods from a source object to DisplayObject.
The source of properties and methods to mix in.
Generated using TypeDoc
The Graphics class is primarily used to render primitive shapes such as lines, circles and rectangles to the display, and to color and fill them. However, you can also use a Graphics object to build a list of primitives to use as a mask, or as a complex hitArea.
Please note that due to legacy naming conventions, the behavior of some functions in this class can be confusing. Each call to
drawRect(),drawPolygon(), etc. actually stores that primitive in the Geometry class's GraphicsGeometry object for later use in rendering or hit testing - the functions do not directly draw anything to the screen. Similarly, theclear()function doesn't change the screen, it simply resets the list of primitives, which can be useful if you want to rebuild the contents of an existing Graphics object.Once a GraphicsGeometry list is built, you can re-use it in other Geometry objects as an optimization, by passing it into a new Geometry object's constructor. Because of this ability, it's important to call
destroy()on Geometry objects once you are done with them, to properly dereference each GraphicsGeometry and prevent memory leaks.Memberof
PIXI