Members
-
Graphics curves resolution settings. If
adaptiveflag is set totrue, the resolution is calculated based on the curve's length to ensure better visual quality. Adaptive draw works withbezierCurveToandquadraticCurveTo.Properties:
Name Type Default Description adaptiveboolean false flag indicating if the resolution should be adaptive
maxLengthnumber 10 maximal length of a single segment of the curve (if adaptive = false, ignored)
minSegmentsnumber 8 minimal number of segments in the curve (if adaptive = false, ignored)
maxSegmentsnumber 2048 maximal number of segments in the curve (if adaptive = false, ignored)
-
alpha number inherited
-
The opacity of the object.
-
The blend mode to be applied to the graphic shape. Apply a value of
PIXI.BLEND_MODES.NORMALto reset the blend mode.- Default Value:
- PIXI.BLEND_MODES.NORMAL;
- See:
-
The bounds' padding used for bounds calculation.
-
buttonMode boolean inherited
-
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'.Example
const sprite = new PIXI.Sprite(texture); sprite.interactive = true; sprite.buttonMode = true; -
cacheAsBitmap boolean overrides
-
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.
- Default Value:
- false
-
children readonly inherited
-
The array of children of this container.
-
cursor string inherited
-
This defines what cursor mode is used when the mouse cursor is hovered over the displayObject.
Example
const sprite = new PIXI.Sprite(texture); sprite.interactive = true; sprite.cursor = 'wait'; -
The alpha value used when filling the Graphics object.
- Default Value:
- 1
-
filterArea PIXI.Rectangle inherited
-
The area the filter is applied to. This is used as more of an optimisation rather than figuring out the dimensions of the displayObject each frame you can set this rectangle
Also works as an interaction mask
-
filters inherited
-
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'
-
height number inherited
-
The height of the Container, setting this will actually modify the scale to achieve the value set
-
hitArea PIXI.Rectangle | PIXI.Circle | PIXI.Ellipse | PIXI.Polygon | PIXI.RoundedRectangle inherited
-
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.
Example
const sprite = new PIXI.Sprite(texture); sprite.interactive = true; sprite.hitArea = new PIXI.Rectangle(0, 0, 100, 100); -
interactive boolean inherited
-
Enable interaction events for the DisplayObject. Touch, pointer and mouse events will not be emitted unless
interactiveis set totrue.Example
const sprite = new PIXI.Sprite(texture); sprite.interactive = true; sprite.on('tap', (event) => { //handle event }); -
interactiveChildren boolean inherited
-
Determines if the children to the displayObject can be clicked/touched Setting this to false allows PixiJS to bypass a recursive
hitTestfunction -
Whether this shape is being used as a mask.
-
The alignment of any lines drawn (0.5 = middle, 1 = outter, 0 = inner).
- Default Value:
- 0.5
-
The color of any lines drawn.
- Default Value:
- 0
-
The width (thickness) of any lines drawn.
- Default Value:
- 0
-
localTransform PIXI.Matrix readonly inherited
-
Current transform of the object based on local factors: position, scale, other stuff
-
mask PIXI.Graphics | PIXI.Sprite inherited
-
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 PIXI a regular mask must be a PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.
- TODO
-
- For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-
name string inherited
-
The instance name of the object.
-
If true the lines will be draw using LINES instead of TRIANGLE_STRIP
-
parent PIXI.Container readonly inherited
-
The display object container that contains this display object.
-
pivot PIXI.Point | PIXI.ObservablePoint inherited
-
The pivot point of the displayObject that it rotates around. Assignment by value since pixi-v4.
-
position PIXI.Point | PIXI.ObservablePoint inherited
-
The coordinate of the object relative to the local coordinates of the parent. Assignment by value since pixi-v4.
-
renderable boolean inherited
-
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
-
rotation number inherited
-
The rotation of the object in radians.
-
scale PIXI.Point | PIXI.ObservablePoint inherited
-
The scale factor of the object. Assignment by value since pixi-v4.
-
The skew factor for the object in radians. Assignment by value since pixi-v4.
-
The tint applied to the graphic shape. This is a hex value. Apply a value of 0xFFFFFF to reset the tint.
- Default Value:
- 0xFFFFFF
-
transform PIXI.TransformBase inherited
-
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
-
visible boolean inherited
-
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
-
width number inherited
-
The width of the Container, setting this will actually modify the scale to achieve the value set
-
worldAlpha number readonly inherited
-
The multiplied alpha of the displayObject
-
worldTransform PIXI.Matrix readonly inherited
-
Current transform of the object based on world (parent) factors
-
worldVisible boolean readonly inherited
-
Indicates if the object is globally visible.
-
x number inherited
-
The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x
-
y number inherited
-
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
Methods
-
_recursivePostUpdateTransform () inherited
-
recursively updates transform of all objects from the root to this one internal function for toLocal()
-
Shortcut for
setAlpha.Name Type Description alphaNumber The alpha amount to use, from 0 to 1
Returns:
Type Description PIXI.DisplayObject Instance for chaining -
ac (x, y, radius, startAngle, endAngle, anticlockwise)PIXI.Graphics overrides
-
Shortcut to
arc.Name Type Description xNumber yNumber radiusNumber startAngleNumber Measured in radians.
endAngleNumber Measured in radians.
anticlockwiseBoolean Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
addChild (child)PIXI.DisplayObject inherited
-
Adds one or more children to the container.
Multiple items can be added like so:
myContainer.addChild(thingOne, thingTwo, thingThree)Name Type Description childPIXI.DisplayObject repeatable The DisplayObject(s) to add to the container
Returns:
Type Description PIXI.DisplayObject The first child that was added. -
addChildAt (child, index)PIXI.DisplayObject inherited
-
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
Name Type Description childPIXI.DisplayObject The child to add
indexnumber The index to place the child in
Returns:
Type Description PIXI.DisplayObject The child that was added. -
addHole ()PIXI.Graphics
-
Adds a hole in the current path.
Returns:
Type Description PIXI.Graphics Returns itself. -
arc (cx, cy, radius, startAngle, endAngle, anticlockwise)PIXI.Graphics
-
The arc method creates an arc/curve (used to create circles, or parts of circles).
Name Type Default Description cxnumber The x-coordinate of the center of the circle
cynumber The y-coordinate of the center of the circle
radiusnumber The radius of the circle
startAnglenumber The starting angle, in radians (0 is at the 3 o'clock position of the arc's circle)
endAnglenumber The ending angle, in radians
anticlockwiseboolean false optional Specifies whether the drawing should be counter-clockwise or clockwise. False is default, and indicates clockwise, while true indicates counter-clockwise.
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
arcTo (x1, y1, x2, y2, radius)PIXI.Graphics
-
The arcTo() method creates an arc/curve between two tangents on the canvas.
"borrowed" from https://code.google.com/p/fxcanvas/ - thanks google!
Name Type Description x1number The x-coordinate of the beginning of the arc
y1number The y-coordinate of the beginning of the arc
x2number The x-coordinate of the end of the arc
y2number The y-coordinate of the end of the arc
radiusnumber The radius of the arc
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
at (x1, y1, x2, y2, radius)PIXI.Graphics
-
Shortcut to
arcTo.Name Type Description x1Number y1Number x2Number y2Number radiusNumber Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
b (cp1x, cp1y, cp2x, cp2y, x, y)PIXI.Graphics
-
Shortcut to
bezierCurveTo.Name Type Description cp1xNumber cp1yNumber cp2xNumber cp2yNumber xNumber yNumber Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
beginFill (color, alpha)PIXI.Graphics
-
Specifies a simple one-color fill that subsequent calls to other Graphics methods (such as lineTo() or drawCircle()) use when drawing.
Name Type Default Description colornumber 0 optional the color of the fill
alphanumber 1 optional the alpha of the fill
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
bezierCurveTo (cpX, cpY, cpX2, cpY2, toX, toY)PIXI.Graphics
-
Calculate the points for a bezier curve and then draws it.
Name Type Description cpXnumber Control point x
cpYnumber Control point y
cpX2number Second Control point x
cpY2number Second Control point y
toXnumber Destination point x
toYnumber Destination point y
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
Placeholder method for a
beginBitmapFill. Pixi does not support bitmap fills.Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
Placeholder method for a
beginBitmapStroke. Pixi does not support bitmap strokes.Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
Closes the current path, effectively drawing a line from the current drawing point to the first drawing point specified since the fill or stroke was last set.
Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
calculateBounds () inherited
-
Recalculates the bounds of the container.
-
clear ()PIXI.Graphics
-
Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
clone ()PIXI.Graphics
-
Creates a new Graphics object with the same values as this one. Note that the only the properties of the object are cloned, not its transform (position,scale,etc)
Returns:
Type Description PIXI.Graphics A clone of the graphics object -
closePath ()PIXI.Graphics
-
Closes the current path.
Returns:
Type Description PIXI.Graphics Returns itself. -
Tests if a point is inside this graphics object
Name Type Description pointPIXI.Point the point to test
Returns:
Type Description boolean the result of the test -
d (commands)PIXI.Graphics
-
Shortcut for
drawCommands.Name Type Description commandsArray The commands and parameters to draw
Returns:
Type Description PIXI.Graphics -
dc (x, y, radius)PIXI.Graphics
-
Shortcut to
drawCircle.Name Type Description xNumber x coordinate center point of circle.
yNumber y coordinate center point of circle.
radiusNumber Radius of circle.
Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
Shortcut to
drawEllipse.Name Type Description xNumber [description]
yNumber [description]
widthNumber [description]
heightNumber [description]
-
destroy (options) overrides
-
Destroys the Graphics object.
Name Type Description optionsobject | boolean optional Options parameter. A boolean will act as if all options have been set to that value
Name Type Default Description childrenboolean false optional if set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.
textureboolean false optional Only used for child Sprites if options.children is set to true Should it destroy the texture of the child sprite
baseTextureboolean false optional Only used for child Sprites if options.children is set to true Should it destroy the base texture of the child sprite
-
dr (x, y, w, h)PIXI.Graphics
-
Shortcut to
drawRect.Name Type Description xNumber yNumber wNumber Width of the rectangle
hNumber Height of the rectangle
Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
drawCircle (x, y, radius)PIXI.Graphics
-
Draws a circle.
Name Type Description xnumber The X coordinate of the center of the circle
ynumber The Y coordinate of the center of the circle
radiusnumber The radius of the circle
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
drawCommands (commands)PIXI.Graphics
-
Execute a series of commands, this is the name of the short function followed by the parameters, e.g.,
["f", "#ff0000", "r", 0, 0, 100, 200]Name Type Description commandsArray The commands and parameters to draw
Returns:
Type Description PIXI.Graphics -
drawEllipse (x, y, width, height)PIXI.Graphics
-
Draws an ellipse.
Name Type Description xnumber The X coordinate of the center of the ellipse
ynumber The Y coordinate of the center of the ellipse
widthnumber The half width of the ellipse
heightnumber The half height of the ellipse
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
drawPolygon (path)PIXI.Graphics
-
Draws a polygon using the given path.
Name Type Description pathArray.<number> | Array.<PIXI.Point> | PIXI.Polygon The path data used to construct the polygon.
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
drawRect (x, y, width, height)PIXI.Graphics
-
Name Type Description xnumber The X coord of the top-left of the rectangle
ynumber The Y coord of the top-left of the rectangle
widthnumber The width of the rectangle
heightnumber The height of the rectangle
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
drawRoundedRect (x, y, width, height, radius)PIXI.Graphics
-
Name Type Description xnumber The X coord of the top-left of the rectangle
ynumber The Y coord of the top-left of the rectangle
widthnumber The width of the rectangle
heightnumber The height of the rectangle
radiusnumber Radius of the rectangle corners
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
drawShape (shape)PIXI.GraphicsData
-
Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.
Name Type Description shapePIXI.Circle | PIXI.Ellipse | PIXI.Polygon | PIXI.Rectangle | PIXI.RoundedRectangle The shape object to draw.
Returns:
Type Description PIXI.GraphicsData The generated GraphicsData object. -
drawStar (x, y, points, radius, innerRadius, rotation)PIXI.Graphics
-
Draw a star shape with an abitrary number of points.
Name Type Default Description xnumber Center X position of the star
ynumber Center Y position of the star
pointsnumber The number of points of the star, must be > 1
radiusnumber The outer radius of the star
innerRadiusnumber optional The inner radius between points, default half
radiusrotationnumber 0 optional The rotation of the star in radians, where 0 is vertical
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
endFill ()PIXI.Graphics
-
Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
f (color, alpha)PIXI.Graphics
-
Shortcut to
beginFill.Name Type Default Description colorUint The hex color value (e.g. 0xFFFFFF) null will result in no fill.
alphaNumber 1 optional The alpha value of fill
Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
generateCanvasTexture (scaleMode, resolution)PIXI.Texture
-
Generates a canvas texture.
Name Type Default Description scaleModenumber The scale mode of the texture.
resolutionnumber 1 The resolution of the texture.
Returns:
Type Description PIXI.Texture The new texture. -
getBounds (skipUpdate, rect)PIXI.Rectangle inherited
-
Retrieves the bounds of the displayObject as a rectangle object.
Name Type Description skipUpdateboolean 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
rectPIXI.Rectangle Optional rectangle to store the result of the bounds calculation
Returns:
Type Description PIXI.Rectangle the rectangular bounding area -
getChildAt (index)PIXI.DisplayObject inherited
-
Returns the child at the specified index
Name Type Description indexnumber The index to get the child at
Returns:
Type Description PIXI.DisplayObject The child at the given index, if any. -
getChildByName (name)PIXI.DisplayObject inherited
-
Returns the display object in the container
Name Type Description namestring instance name
Returns:
Type Description PIXI.DisplayObject The child with the specified name. -
getChildIndex (child)number inherited
-
Returns the index position of a child DisplayObject instance
Name Type Description childPIXI.DisplayObject The DisplayObject instance to identify
Returns:
Type Description number The index position of the child display object to identify -
getGlobalPosition (point, skipUpdate)Point inherited
-
Returns the global position of the displayObject. Does not depend on object scale, rotation and pivot.
Name Type Description pointPoint the point to write the global value to. If null a new point will be returned
skipUpdateboolean 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
Returns:
Type Description Point The updated point -
getLocalBounds (rect)PIXI.Rectangle inherited
-
Retrieves the local bounds of the displayObject as a rectangle object
Name Type Description rectPIXI.Rectangle optional Optional rectangle to store the result of the bounds calculation
Returns:
Type Description PIXI.Rectangle the rectangular bounding area -
Alias for
addHoleReturns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
True if graphics consists of one rectangle, and thus, can be drawn like a Sprite and masked with gl.scissor.
Returns:
Type Description boolean True if only 1 rect. -
l (x, y)PIXI.Graphics
-
Shortcut to
lineTo.Name Type Description xNumber The x coordinate the drawing point should draw to.
yNumber The y coordinate the drawing point should draw to.
Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
lf (colorArray)PIXI.Graphics
-
Placeholder method for a linear fill. Pixi does not support linear fills, so we just pick the first color in colorArray
Name Type Description colorArrayArray An array of CSS compatible color values @see
fReturns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
lineStyle (lineWidth, color, alpha, alignment)PIXI.Graphics
-
Specifies the line style used for subsequent calls to Graphics methods such as the lineTo() method or the drawCircle() method.
Name Type Default Description lineWidthnumber 0 optional width of the line to draw, will update the objects stored style
colornumber 0 optional color of the line to draw, will update the objects stored style
alphanumber 1 optional alpha of the line to draw, will update the objects stored style
alignmentnumber 0.5 optional alignment of the line to draw, (0 = inner, 0.5 = middle, 1 = outter)
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
lineTo (x, y)PIXI.Graphics
-
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).
Name Type Description xnumber the X coordinate to draw to
ynumber the Y coordinate to draw to
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
Placeholder method for a
beginLinearGradientStroke. Pixi does not support gradient strokes.Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
m (x, y)PIXI.Graphics
-
Shortcut to
moveTo.Name Type Description xNumber The x coordinate the drawing point should move to.
yNumber The y coordinate the drawing point should move to.
Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls). -
Shortcut for
setMask.Name Type Description maskPIXI.Sprite | PIXI.Graphics The mask shape to use
Returns:
Type Description PIXI.DisplayObject Instance for chaining -
moveTo (x, y)PIXI.Graphics
-
Moves the current drawing position to x, y.
Name Type Description xnumber the X coordinate to move to
ynumber the Y coordinate to move to
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
q (cpx, cpy, x, y)PIXI.Graphics
-
Draws a quadratic curve from the current drawing point to (x, y) using the control point (cpx, cpy). For detailed information, read the whatwg spec. A tiny API method "qt" also exists.
Name Type Description cpxNumber cpyNumber xNumber yNumber Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
quadraticCurveTo (cpX, cpY, toX, toY)PIXI.Graphics
-
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
Name Type Description cpXnumber Control point x
cpYnumber Control point y
toXnumber Destination point x
toYnumber Destination point y
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
r (x, y, w, h)PIXI.Graphics
-
Shortcut to
drawRect.Name Type Description xNumber yNumber wNumber Width of the rectangle
hNumber Height of the rectangle
Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
rc (x, y, w, h, radiusTL, radiusTR, radiusBR, radiusBL)PIXI.Graphics
-
Shortcut to
drawRoundedRect.Name Type Description xNumber yNumber wNumber Width of the rectangle
hNumber Height of the rectangle
radiusTLNumber The top left corner radius
radiusTRNumber The top right corner radius
radiusBRNumber The bottom right corner radius
radiusBLNumber The bottom left corner radius
Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
re (renderable)PIXI.DisplayObject inherited
-
Shortcut to
setRenderable.Name Type Default Description renderableBoolean false optional Make renderable
Returns:
Type Description PIXI.DisplayObject -
removeChild (child)PIXI.DisplayObject inherited
-
Removes one or more children from the container.
Name Type Description childPIXI.DisplayObject repeatable The DisplayObject(s) to remove
Returns:
Type Description PIXI.DisplayObject The first child that was removed. -
removeChildAt (index)PIXI.DisplayObject inherited
-
Removes a child from the specified index position.
Name Type Description indexnumber The index to get the child from
Returns:
Type Description PIXI.DisplayObject The child that was removed. -
removeChildren (beginIndex, endIndex) inherited
-
Removes all children from this container that are within the begin and end indexes.
Name Type Default Description beginIndexnumber 0 optional The beginning position.
endIndexnumber this.children.length optional The ending position. Default value is size of the container.
Returns:
Type Description List of removed children -
renderCanvas (renderer) inherited
-
Renders the object using the Canvas renderer
Name Type Description rendererPIXI.CanvasRenderer The renderer
-
renderWebGL (renderer) inherited
-
Renders the object using the WebGL renderer
Name Type Description rendererPIXI.WebGLRenderer The renderer
-
rf (colorArray)PIXI.Graphics
-
Placeholder method for a radial fill. Pixi does not support radial fills, so we just pick the first color in colorArray
Name Type Description colorArrayArray An array of CSS compatible color values @see
fReturns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
rr (x, y, w, h, radius)PIXI.Graphics
-
Shortcut to
drawRoundedRect.Name Type Description xNumber yNumber wNumber Width of the rectangle
hNumber Height of the rectangle
radiusNumber The corner radius
Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
Placeholder method for a
beginRadialGradientStroke. Pixi does not support gradient strokes.Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
s (color, thickness, alpha)PIXI.Graphics
-
Shortcut to
lineStyle.Name Type Default Description colorString A CSS compatible color value (ex. "#FF0000", "red", or "rgba(255,0,0,0.5)"). Setting to null will result in no stroke.
thicknessNumber 1 optional The thickness of the stroke
alphaNumber 1 optional The alpha value from 0 (invisibile) to 1 (visible)
Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
Placeholder method for a
setStrokeDash. Pixi does not support dashed strokes.Returns:
Type Description PIXI.Graphics The Graphics instance the method is called on (useful for chaining calls.) -
setAlpha (alpha)PIXI.DisplayObject inherited
-
Setter for the alpha
Name Type Description alphaNumber The alpha amount to use, from 0 to 1
Returns:
Type Description PIXI.DisplayObject Instance for chaining -
setChildIndex (child, index) inherited
-
Changes the position of an existing child in the display object container
Name Type Description childPIXI.DisplayObject The child DisplayObject instance for which you want to change the index number
indexnumber The resulting index number for the child display object
-
setColorTransform (r, rA, g, gA, b, bA)PIXI.DisplayObject inherited
-
Set additive and multiply color, tinting
Name Type Description rNumber The multiply red value
rANumber The additive red value
gNumber The multiply green value
gANumber The additive green value
bNumber The multiply blue value
bANumber The additive blue value
Returns:
Type Description PIXI.DisplayObject Object for chaining -
setMask (mask)PIXI.DisplayObject inherited
-
Setter for mask to be able to chain.
Name Type Description maskPIXI.Graphics The mask shape to use
Returns:
Type Description PIXI.DisplayObject Instance for chaining -
setParent (container)PIXI.Container inherited
-
Set the parent Container of this DisplayObject
Name Type Description containerPIXI.Container The Container to add this DisplayObject to
Returns:
Type Description PIXI.Container The Container that this DisplayObject was added to -
setRenderable (renderable)PIXI.DisplayObject inherited
-
Function to see if this is renderable or not. Useful for setting masks.
Name Type Default Description renderableBoolean false optional Make renderable
Returns:
Type Description PIXI.DisplayObject -
setTint (tint)PIXI.DisplayObject inherited
-
Set the tint values by color.
Name Type Description tintint The color value to tint
Returns:
Type Description PIXI.DisplayObject Object for chaining -
setTransform (x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY)PIXI.DisplayObject inherited
-
Convenience function to set the position, scale, skew and pivot at once.
Name Type Default Description xnumber 0 optional The X position
ynumber 0 optional The Y position
scaleXnumber 1 optional The X scale value
scaleYnumber 1 optional The Y scale value
rotationnumber 0 optional The rotation
skewXnumber 0 optional The X skew value
skewYnumber 0 optional The Y skew value
pivotXnumber 0 optional The X pivot value
pivotYnumber 0 optional The Y pivot value
Returns:
Type Description PIXI.DisplayObject The DisplayObject instance -
swapChildren (child, child2) inherited
-
Swaps the position of 2 Display Objects within this container.
Name Type Description childPIXI.DisplayObject First display object to swap
child2PIXI.DisplayObject Second display object to swap
-
Shortcut to
setTint.Name Type Description tintNumber | String The red percentage value
Returns:
Type Description PIXI.DisplayObject Object for chaining -
toGlobal (position, point, skipUpdate)PIXI.Point inherited
-
Calculates the global position of the display object
Name Type Default Description positionPIXI.Point The world origin to calculate from
pointPIXI.Point optional A Point object in which to store the value, optional (otherwise will create a new Point)
skipUpdateboolean false optional Should we skip the update transform.
Returns:
Type Description PIXI.Point A point object representing the position of this object -
toLocal (position, from, point, skipUpdate)PIXI.Point inherited
-
Calculates the local position of the display object relative to another point
Name Type Default Description positionPIXI.Point The world origin to calculate from
fromPIXI.DisplayObject optional The DisplayObject to calculate the global position from
pointPIXI.Point optional A Point object in which to store the value, optional (otherwise will create a new Point)
skipUpdateboolean false optional Should we skip the update transform
Returns:
Type Description PIXI.Point A point object representing the position of this object -
tr (x, y, scaleX, scaleY, skewX, skewY, pivotX, pivotY)PIXI.DisplayObject inherited
-
Shortcut for
setTransform.Name Type Description xNumber The X position
yNumber The Y position
scaleXNumber The X Scale value
scaleYNumber The Y Scale value
skewXNumber The X skew value
skewYNumber The Y skew value
pivotXNumber The X pivot value
pivotYNumber The Y pivot value
Returns:
Type Description PIXI.DisplayObject Instance for chaining -
Update the bounds of the object
-
updateTransform () inherited
-
Updates the transform on all children of this container for rendering
Events
-
Fired when this DisplayObject is added to a Container.
Name Type Description containerPIXI.Container The container added to.
-
Fired when a pointer device button (usually a mouse left-button) is pressed and released on the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
mousedown inherited
-
Fired when a pointer device button (usually a mouse left-button) is pressed on the display. object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
mousemove inherited
-
Fired when a pointer device (usually a mouse) is moved while over the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
mouseout inherited
-
Fired when a pointer device (usually a mouse) is moved off the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
mouseover inherited
-
Fired when a pointer device (usually a mouse) is moved onto the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
mouseup inherited
-
Fired when a pointer device button (usually a mouse left-button) is released over the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
mouseupoutside inherited
-
Fired when a pointer device button (usually a mouse left-button) is released outside the display object that initially registered a mousedown. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
pointercancel inherited
-
Fired when the operating system cancels a pointer event. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
pointerdown inherited
-
Fired when a pointer device button is pressed on the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
pointermove inherited
-
Fired when a pointer device is moved while over the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
pointerout inherited
-
Fired when a pointer device is moved off the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
pointerover inherited
-
Fired when a pointer device is moved onto the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
pointertap inherited
-
Fired when a pointer device button is pressed and released on the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
pointerup inherited
-
Fired when a pointer device button is released over the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
pointerupoutside inherited
-
Fired when a pointer device button is released outside the display object that initially registered a pointerdown. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
removed inherited
-
Fired when this DisplayObject is removed from a Container.
Name Type Description containerPIXI.Container The container removed from.
-
rightclick inherited
-
Fired when a pointer device secondary button (usually a mouse right-button) is pressed and released on the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
rightdown inherited
-
Fired when a pointer device secondary button (usually a mouse right-button) is pressed on the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
rightup inherited
-
Fired when a pointer device secondary button (usually a mouse right-button) is released over the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
rightupoutside inherited
-
Fired when a pointer device secondary button (usually a mouse right-button) is released outside the display object that initially registered a rightdown. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
Fired when a touch point is placed and removed from the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
touchcancel inherited
-
Fired when the operating system cancels a touch. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
touchend inherited
-
Fired when a touch point is removed from the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
touchendoutside inherited
-
Fired when a touch point is removed outside of the display object that initially registered a touchstart. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
touchmove inherited
-
Fired when a touch point is moved along the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event
-
touchstart inherited
-
Fired when a touch point is placed on the display object. DisplayObject's
interactiveproperty must be set totrueto fire event.Name Type Description eventPIXI.interaction.InteractionEvent Interaction event