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_If the object has been destroyed via destroy(). If true, it should not be used.
Protected_Currently enabled filters
Protected_Current fill style
Protected_Current hole mode is enabled.
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.
Protected_Current line style
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.
Protected_Current shape transform matrix.
Protected_Protected_The zIndex of the displayObject. A higher value will mean it will be rendered on top of other displayObjects within the same container.
Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set
Setting to false will prevent any children inside this container to be accessible. Defaults to true.
Sets the aria-label attribute of the shadow div
Specify the pointer-events the accessible div will use Defaults to auto.
Sets the title attribute of the shadow div If accessibleTitle AND accessibleHint has not been this will default to 'displayObject [tabIndex]'
Specify the type of div the accessible layer is. Screen readers treat the element differently depending on this type. Defaults to button.
The opacity of the object.
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.
ProtectedbatchUpdate dirty for limiting calculating batches.
ProtectedbatchesA collections of batches! These can be drawn by the renderer batch system.
ProtectedbatchUpdate dirty for limiting calculating tints for batches.
The blend mode to be applied to the graphic shape. Apply a value of
PIXI.BLEND_MODES.NORMAL to reset the blend mode.
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'.
When cacheAsBitmap is set to true the graphics object will be rendered as if it was a sprite. This is useful if your graphics element does not change often, as it will speed up the rendering of the object in exchange for taking up texture memory. It is also useful if you need the graphics object to be anti-aliased, because it will be rendered using canvas. This is not recommended if you are constantly redrawing the graphics element.
ReadonlychildrenThe array of children of this container.
ProtectedcurrentCurrent path
This defines what cursor mode is used when the mouse cursor is hovered over the displayObject.
ReadonlyfillThe current fill style.
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.
'null'.ReadonlygeometryIncludes 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
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.
Enable interaction events for the DisplayObject. Touch, pointer and mouse
events will not be emitted unless interactive is set to true.
Determines if the children to the displayObject can be clicked/touched
Setting this to false allows PixiJS to bypass a recursive hitTest function
Does any other displayObject use this object as a mask?
used to fast check if a sprite is.. a sprite!
ReadonlylineThe current line style.
ReadonlylocalCurrent 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.
The instance name of the object.
The display object container that contains this display object.
The pivot point of the displayObject that it rotates around. Assignment by value since pixi-v4.
Renderer plugin for batching
The coordinate of the object relative to the local coordinates of the parent. Assignment by value since pixi-v4.
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.
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 factor of the object. Assignment by value since pixi-v4.
Represents the vertex and fragment shaders that processes the geometry and runs on the GPU. Can be shared between multiple Graphics objects.
The skew factor for the object in radians. Assignment by value since pixi-v4.
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
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.
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.
Represents the WebGL state the Graphics required to render, excludes shader and geometry. E.g., blend mode, culling, depth testing, direction of rendering triangles, backface, etc.
The tint applied to the graphic shape. This is a hex value. A value of 0xFFFFFF will remove any tint effect.
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.
ProtectedvertexCopy of the object vertex data.
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.
The width of the Container, setting this will actually modify the scale to achieve the value set
ReadonlyworldThe multiplied alpha of the displayObject.
ReadonlyworldCurrent transform of the object based on world (parent) factors.
ReadonlyworldIndicates 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 displayObjects within the same container.
Protected_Protected
Retrieves the bounds of the graphic shape as a rectangle object
Protected_Protected
Initialize the curve
Optionalx: numberOptionaly: numberProtected_Protected
Populating batches for rendering
Recursively updates transform of all objects from the root to this one internal function for toLocal()
Protected_Protected
Renders the object using the WebGL renderer
The renderer
Protected_Protected
Renders the batches using the BathedRenderer plugin
The renderer
Protected_Protected
Renders the graphics direct
The renderer
Renders specific DrawCall
Protected_Protected
Resolves shader for direct rendering
The renderer
Adds one or more children to the container.
Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)
The DisplayObject(s) to add to the container
The first child that was added.
The 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
Optionalanticlockwise: boolean
Specifies whether the drawing should be counter-clockwise or clockwise. False is default, and indicates clockwise, while true indicates counter-clockwise.
This Graphics object. Good for chaining method calls
The arcTo() method creates an arc/curve between two tangents on the canvas.
"borrowed" from https://code.google.com/p/fxcanvas/ - thanks google!
The x-coordinate of the first tangent point of the arc
The y-coordinate of the first tangent point of the arc
The x-coordinate of the end of the arc
The y-coordinate of the end of the arc
The radius of the arc
This Graphics object. Good for chaining method calls
Specifies a simple one-color fill that subsequent calls to other Graphics methods (such as lineTo() or drawCircle()) use when drawing.
Optionalcolor: number
the color of the fill
Optionalalpha: number
the alpha of the fill
This Graphics object. Good for chaining method calls
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.
Returns itself.
Begin the texture fill
Optionaloptions: { alpha?: number; color?: number; matrix?: Matrix; texture?: Texture }
Object object.
Optionalalpha?: numberAlpha of fill
Optionalcolor?: numberBackground to fill behind texture
Optionalmatrix?: MatrixTransform matrix
Optionaltexture?: TextureTexture to fill
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
Recalculates the bounds of the container.
ProtectedcalculateProtected
Recalcuate the tint by applying tin to batches using Graphics tint.
ProtectedcalculateProtected
If there's a transform update or a change to the shape of the geometry, recaculate the vertices.
Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.
This Graphics object. Good for chaining method calls
Creates a new Graphics object with the same values as this one. Note that only the geometry of the object is cloned, not its transform (position,scale,etc)
A clone of the graphics object
Closes the current path.
Returns itself.
Tests if a point is inside this graphics object
the point to test
the result of the test
Destroys the Graphics object.
Optionaloptions: { baseTexture?: boolean; children?: boolean; texture?: boolean }
Options parameter. A boolean will act as if all options have been set to that value
OptionalbaseTexture?: booleanOnly used for child Sprites if options.children is set to true Should it destroy the base texture of the child sprite
Optionalchildren?: booleanif set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.
Optionaltexture?: booleanOnly used for child Sprites if options.children is set to true Should it destroy the texture of the child sprite
Pair method for enableTempParent
actual parent of element
Draw Rectangle with chamfer corners.
Note: Only available with @pixi/graphics-extras.
Upper left corner of rect
Upper right corner of rect
Width of rect
Height of rect
accept negative or positive values
Returns self.
Draws a circle.
The X coordinate of the center of the circle
The Y coordinate of the center of the circle
The radius of the circle
This Graphics object. Good for chaining method calls
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
This Graphics object. Good for chaining method calls
Draw Rectangle with fillet corners.
Note: Only available with @pixi/graphics-extras.
Upper left corner of rect
Upper right corner of rect
Width of rect
Height of rect
non-zero real number, size of corner cutout
Returns self.
Draws a polygon using the given path.
The path data used to construct the polygon.
This Graphics object. Good for chaining method calls
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
This Graphics object. Good for chaining method calls
Draw a regular polygon where all sides are the same length.
Note: Only available with @pixi/graphics-extras.
X position
Y position
Polygon radius
Minimum value is 3
Starting rotation values in radians..
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
This Graphics object. Good for chaining method calls
Draw any shape.
Shape to draw
This Graphics object. Good for chaining method calls
Draw a star shape with an arbitrary number of points.
Center X position of the star
Center Y position of the star
The number of points of the star, must be > 1
The outer radius of the star
OptionalinnerRadius: number
The inner radius between points, default half radius
Optionalrotation: number
The rotation of the star in radians, where 0 is vertical
This Graphics object. Good for chaining method calls
Draw a torus shape, like a donut. Can be used for something like a circle loader.
Note: Only available with @pixi/graphics-extras.
X position
Y position
Inner circle radius
Outer circle radius
OptionalstartArc: number
Where to begin sweep, in radians, 0.0 = to the right
OptionalendArc: number
Where to end sweep, in radians
Calls each of the listeners registered for a given event.
The event name.
Arguments that are passed to registered listeners
true if the event had listeners, else false.
Used in Renderer, cacheAsBitmap and other places where you call an updateTransform on root
const cacheParent = elem.enableTempParent();
elem.updateTransform();
elem.disableTempParent(cacheParent);
current parent
Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.
This Graphics object. Good for chaining method calls
End adding holes to the last draw shape
Returns itself.
Return an array listing the events for which the emitter has registered listeners.
ProtectedfinishProtected
Finish the polygon object.
Retrieves the bounds of the displayObject as a rectangle object.
OptionalskipUpdate: boolean
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.
Optionalrect: Rectangle
Optional rectangle to store the result of the bounds calculation.
The rectangular bounding area.
Returns the child at the specified index
The index to get the child at
The child at the given index, if any.
Returns the index position of a child DisplayObject instance
The DisplayObject instance to identify
The index position of the child display object to identify
Returns the global position of the displayObject. Does not depend on object scale, rotation and pivot.
Optionalpoint: Point
The point to write the global value to.
OptionalskipUpdate: boolean
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.
The updated point.
Retrieves the local bounds of the displayObject as a rectangle object.
Optionalrect: Rectangle
Optional rectangle to store the result of the bounds calculation.
OptionalskipChildrenUpdate: boolean
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.
The rectangular bounding area.
True if graphics consists of one rectangle, and thus, can be drawn like a Sprite and masked with gl.scissor.
True if only 1 rect.
Specifies the line style used for subsequent calls to Graphics methods such as the lineTo() method or the drawCircle() method.
Optionalwidth: number
width of the line to draw, will update the objects stored style
Optionalcolor: number
color of the line to draw, will update the objects stored style
Optionalalpha: number
alpha of the line to draw, will update the objects stored style
Optionalalignment: number
alignment of the line to draw, (0 = inner, 0.5 = middle, 1 = outter)
Optionalnative: boolean
If true the lines will be draw using LINES instead of TRIANGLE_STRIP
This Graphics object. Good for chaining method calls
Specifies the line style used for subsequent calls to Graphics methods such as the lineTo() method or the drawCircle() method.
Optionalwidth: number
width of the line to draw, will update the objects stored style
Optionalcolor: number
color of the line to draw, will update the objects stored style
Optionalalpha: number
alpha of the line to draw, will update the objects stored style
Optionalalignment: number
alignment of the line to draw, (0 = inner, 0.5 = middle, 1 = outter)
Optionalnative: boolean
If true the lines will be draw using LINES instead of TRIANGLE_STRIP
This Graphics object. Good for chaining method calls
Like line style but support texture for line fill.
Optionaloptions: {Collection of options for setting line style.
Optionalalignment?: numberalignment of the line to draw, (0 = inner, 0.5 = middle, 1 = outter)
Optionalalpha?: numberalpha of the line to draw, will update the objects stored style
Optionalcap?: LINE_CAPline cap style
Optionalcolor?: numbercolor of the line to draw, will update the objects stored style. Default 0xFFFFFF if texture present.
Optionaljoin?: LINE_JOINline join style
Optionalmatrix?: MatrixTexture matrix to transform texture
OptionalmiterLimit?: numbermiter limit ratio
Optionalnative?: booleanIf true the lines will be draw using LINES instead of TRIANGLE_STRIP
Optionaltexture?: TextureTexture to use
Optionalwidth?: numberwidth of the line to draw, will update the objects stored 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
This Graphics object. Good for chaining method calls
Return the number of listeners listening to a given event.
The event name.
Return the listeners registered for a given event.
The event name.
Moves the current drawing position to x, y.
the X coordinate to move to
the Y coordinate to move to
This Graphics object. Good for chaining method calls
Optionalfn: FunctionOptionalcontext: anyOptionalcontext: anyOptionalcontext: anyOptionalcontext: anyOptionalcontext: anyProtectedonProtected
Overridable method that can be used by Container subclasses whenever the children array is modified
Calculate 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
This Graphics object. Good for chaining method calls
Optionalevent: InteractionEventTypesOptionalevent: string | symbolRemoves 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: number
The beginning position.
OptionalendIndex: number
The ending position. Default value is size of the container.
List of removed children
Optionalfn: (event: InteractionEvent) => voidOptionalcontext: anyOptionalfn: FunctionOptionalcontext: anyRenders the object using the WebGL renderer
The renderer
ProtectedrenderProtected
Render 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
Apply a matrix to the positional data.
Matrix to use for transform current shape.
Returns itself.
Set the parent Container of this DisplayObject.
The Container to add this DisplayObject to.
The Container that this DisplayObject was added to.
Convenience function to set the position, scale, skew and pivot at once.
Optionalx: number
The X position
Optionaly: number
The Y position
OptionalscaleX: number
The X scale value
OptionalscaleY: number
The Y scale value
Optionalrotation: number
The rotation
OptionalskewX: number
The X skew value
OptionalskewY: number
The Y skew value
OptionalpivotX: number
The X pivot value
OptionalpivotY: number
The Y pivot value
The DisplayObject instance
Sorts children by zIndex. Previous order is mantained for 2 children with the same zIndex.
ProtectedstartProtected
Start a polygon object internally
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: Point
A Point object in which to store the value, optional (otherwise will create a new Point).
OptionalskipUpdate: boolean
Should we skip the update transform.
A point object representing the position of this object.
Calculates the local position of the display object relative to another point.
The world origin to calculate from.
Optionalfrom: DisplayObject
The DisplayObject to calculate the global position from.
Optionalpoint: Point
A Point object in which to store the value, optional (otherwise will create a new Point).
OptionalskipUpdate: boolean
Should we skip the update transform
A point object representing the position of this object
Updates the transform on all children of this container for rendering
StaticmixinMixes all enumerable properties and methods from a source object to DisplayObject.
The source of properties and methods to mix in.
inherited PIXI.Graphics