PixiJS

Class: RawMesh

PIXI.RawMesh

Base mesh class. The reason for this class is to empower you to have maximum flexbilty to render any kind of webGL you can think of. This class assumes a certain level of webGL knowledge. If you know a bit this should abstract enough away to make you life easier! Pretty much ALL WebGL can be broken down into the following: Geometry - The structure and data for the mesh. This can include anything from positions, uvs, normals, colors etc.. Shader - This is the shader that pixi will render the geometry with. (attributes in the shader must match the geometry!) Uniforms - These are the values passed to the shader when the mesh is rendered. As a shader can be resued accross multiple objects, it made sense to allow uniforms to exist outside of the shader State - This is the state of WebGL required to render the mesh. Through a combination of the above elements you can render anything you want, 2D or 3D!

new PIXI.RawMesh (geometry, shader, state, drawMode)

RawMesh.js:28
Name Type Description
geometry PIXI.Geometry

the geometry the mesh will use
shader PIXI.Shader

the shader the mesh will use
state PIXI.State

the state that the webGL context is required to be in to render the mesh
drawMode number

the drawMode, can be any of the PIXI.DRAW_MODES consts

Extends

Members

alpha number inherited

The opacity of the object.

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 inherited

Set this to true if you want this display object to be cached as a bitmap. This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects. To remove simply set this property to 'false'

IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.

children Array.<PIXI.DisplayObject> 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.

See:
Example
const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.cursor = 'wait';

drawMode number

The way the Mesh should be drawn, can be any of the PIXI.RawMesh.DRAW_MODES consts

See:
  • PIXI.RawMesh.DRAW_MODES

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 Array.<PIXI.Filter> 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'

geometry PIXI.Geometry

the geometry the mesh will use

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 interactive is set to true.

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 hitTest function

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.

For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.

TODO
  • For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.

name string inherited

The instance name of the object.

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.

pluginName string

Plugin that is responsible for rendering this element. Allows to customize the rendering process without overriding '_render' & '_renderCanvas' methods.

Default Value:
  • 'mesh'

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.

shader PIXI.Shader

the shader the mesh will use

skew PIXI.ObservablePoint inherited

The skew factor for the object in radians. Assignment by value since pixi-v4.

state PIXI.State

the webGL state the mesh requires to render

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

DisplayObject.js:175

recursively updates transform of all objects from the root to this one internal function for toLocal()

addChild (child)PIXI.DisplayObject inherited

Container.js:55

Adds one or more children to the container.

Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)

Name Type Description
child PIXI.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

Container.js:101

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
child PIXI.DisplayObject

The child to add
index number

The index to place the child in
Returns:
Type Description
PIXI.DisplayObject The child that was added.

calculateBounds () inherited

Container.js:345

Recalculates the bounds of the container.

containsPoint (point)boolean

RawMesh.js:128

Tests if a point is inside this mesh. Works only for TRIANGLE_MESH

Name Type Description
point PIXI.Point

the point to test
Returns:
Type Description
boolean the result of the test

destroy (options) inherited

Container.js:509

Removes all internal references and listeners as well as removes children from the display list. Do not use a Container after calling destroy.

Name Type Description
options object | boolean optional

Options parameter. A boolean will act as if all options have been set to that value

Name Type Default Description
children boolean 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.
texture boolean false optional

Only used for child Sprites if options.children is set to true Should it destroy the texture of the child sprite
baseTexture boolean false optional

Only used for child Sprites if options.children is set to true Should it destroy the base texture of the child sprite

getBounds (skipUpdate, rect)PIXI.Rectangle inherited

DisplayObject.js:197

Retrieves the bounds of the displayObject as a rectangle object.

Name Type Description
skipUpdate 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
rect PIXI.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

Container.js:195

Returns the child at the specified index

Name Type Description
index number

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

index.js:11

Returns the display object in the container

Name Type Description
name string

instance name
Returns:
Type Description
PIXI.DisplayObject The child with the specified name.

getChildIndex (child)number inherited

Container.js:156

Returns the index position of a child DisplayObject instance

Name Type Description
child PIXI.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

index.js:4

Returns the global position of the displayObject. Does not depend on object scale, rotation and pivot.

Name Type Description
point Point

the point to write the global value to. If null a new point will be returned
skipUpdate 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
Returns:
Type Description
Point The updated point

getLocalBounds (rect)PIXI.Rectangle inherited

DisplayObject.js:238

Retrieves the local bounds of the displayObject as a rectangle object

Name Type Description
rect PIXI.Rectangle optional

Optional rectangle to store the result of the bounds calculation
Returns:
Type Description
PIXI.Rectangle the rectangular bounding area

removeChild (child)PIXI.DisplayObject inherited

Container.js:211

Removes one or more children from the container.

Name Type Description
child PIXI.DisplayObject repeatable

The DisplayObject(s) to remove
Returns:
Type Description
PIXI.DisplayObject The first child that was removed.

removeChildAt (index)PIXI.DisplayObject inherited

Container.js:253

Removes a child from the specified index position.

Name Type Description
index number

The index to get the child from
Returns:
Type Description
PIXI.DisplayObject The child that was removed.

removeChildren (beginIndex, endIndex)Array.<DisplayObject> inherited

Container.js:279

Removes all children from this container that are within the begin and end indexes.

Name Type Default Description
beginIndex number 0 optional

The beginning position.
endIndex number this.children.length optional

The ending position. Default value is size of the container.
Returns:
Type Description
Array.<DisplayObject> List of removed children

render (renderer) inherited

Container.js:396

Renders the object using the WebGL renderer

Name Type Description
renderer PIXI.Renderer

The renderer

renderAdvancedWebGL (renderer) Deprecated : since 5.0.0 inherited

deprecated.js:601
Name Type Description
renderer PIXI.Renderer

Instance of renderer
See:
  • PIXI.Container#renderAdvanced

renderWebGL (renderer) Deprecated : since 5.0.0 inherited

deprecated.js:575
Name Type Description
renderer PIXI.Renderer

Instance of renderer
See:

setChildIndex (child, index) inherited

Container.js:174

Changes the position of an existing child in the display object container

Name Type Description
child PIXI.DisplayObject

The child DisplayObject instance for which you want to change the index number
index number

The resulting index number for the child display object

setParent (container)PIXI.Container inherited

DisplayObject.js:354

Set the parent Container of this DisplayObject

Name Type Description
container PIXI.Container

The Container to add this DisplayObject to
Returns:
Type Description
PIXI.Container The Container that this DisplayObject was added to

setTransform (x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY)PIXI.DisplayObject inherited

DisplayObject.js:380

Convenience function to set the position, scale, skew and pivot at once.

Name Type Default Description
x number 0 optional

The X position
y number 0 optional

The Y position
scaleX number 1 optional

The X scale value
scaleY number 1 optional

The Y scale value
rotation number 0 optional

The rotation
skewX number 0 optional

The X skew value
skewY number 0 optional

The Y skew value
pivotX number 0 optional

The X pivot value
pivotY number 0 optional

The Y pivot value
Returns:
Type Description
PIXI.DisplayObject The DisplayObject instance

swapChildren (child, child2) inherited

Container.js:135

Swaps the position of 2 Display Objects within this container.

Name Type Description
child PIXI.DisplayObject

First display object to swap
child2 PIXI.DisplayObject

Second display object to swap

toGlobal (position, point, skipUpdate)PIXI.Point inherited

DisplayObject.js:273

Calculates the global position of the display object

Name Type Default Description
position PIXI.Point

The world origin to calculate from
point PIXI.Point optional

A Point object in which to store the value, optional (otherwise will create a new Point)
skipUpdate boolean 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

DisplayObject.js:308

Calculates the local position of the display object relative to another point

Name Type Default Description
position PIXI.Point

The world origin to calculate from
from PIXI.DisplayObject optional

The DisplayObject to calculate the global position from
point PIXI.Point optional

A Point object in which to store the value, optional (otherwise will create a new Point)
skipUpdate boolean false optional

Should we skip the update transform
Returns:
Type Description
PIXI.Point A point object representing the position of this object

updateTransform () inherited

Container.js:321

Updates the transform on all children of this container for rendering