PixiJS

Class: MeshGeometry

PIXI.MeshGeometry

Standard 2D geometry used in PixiJS.

Geometry can be defined without passing in a style or data if required.

const geometry = new PIXI.Geometry();

geometry.addAttribute('positions', [0, 0, 100, 0, 100, 100, 0, 100], 2);
geometry.addAttribute('uvs', [0,0,1,0,1,1,0,1], 2);
geometry.addIndex([0,1,2,1,3,2]);

new PIXI.MeshGeometry (vertices, uvs, index)

MeshGeometry.js:22
Name Type Description
vertices Float32Array | Array.<number>

Positional data on geometry.
uvs Float32Array | Array.<number>

Texture UVs.
index Uint16Array | Array.<number>

IndexBuffer

Extends

Members

glVertexArrayObjects object protected inherited

A map of renderer IDs to webgl VAOs

instanceCount number inherited

Number of instances in this geometry, pass it to GeometrySystem.draw()

Default Value:
  • 1

refCount number inherited

Count of existing (not destroyed) meshes that reference this geometry

Methods

addAttribute (id, buffer, size, normalized, type, stride, start)PIXI.Geometry inherited

Geometry.js:85

Adds an attribute to the geometry

Name Type Default Description
id String

the name of the attribute (matching up to a shader)
buffer PIXI.Buffer | Array.<number> optional

the buffer that holds the data of the attribute . You can also provide an Array and a buffer will be created from it.
size Number 0 optional

the size of the attribute. If you have 2 floats per vertex (eg position x and y) this would be 2
normalized Boolean false optional

should the data be normalized.
type Number PIXI.TYPES.FLOAT optional

what type of number is the attribute. Check {PIXI.TYPES} to see the ones available
stride Number 0 optional

How far apart (in floats) the start of each value is. (used for interleaving data)
start Number 0 optional

How far into the array to start reading values (used for interleaving data)
Returns:
Type Description
PIXI.Geometry returns self, useful for chaining.

addIndex (buffer)PIXI.Geometry inherited

Geometry.js:153

Adds an index buffer to the geometry The index buffer contains integers, three for each triangle in the geometry, which reference the various attribute buffers (position, colour, UV coordinates, other UV coordinates, normal, …). There is only ONE index buffer.

Name Type Description
buffer PIXI.Buffer | Array.<number> optional

the buffer that holds the data of the index buffer. You can also provide an Array and a buffer will be created from it.
Returns:
Type Description
PIXI.Geometry returns self, useful for chaining.

clone ()PIXI.Geometry inherited

Geometry.js:258

returns a clone of the geometry

Returns:
Type Description
PIXI.Geometry a new clone of this geometry

destroy () inherited

Geometry.js:246

Destroys the geometry.

dispose () inherited

Geometry.js:239

disposes WebGL resources that are connected to this geometry

getAttribute (id)PIXI.Attribute inherited

Geometry.js:131

returns the requested attribute

Name Type Description
id String

the name of the attribute required
Returns:
Type Description
PIXI.Attribute the attribute requested.

getBuffer (id)PIXI.Buffer inherited

Geometry.js:141

returns the requested buffer

Name Type Description
id String

the name of the buffer required
Returns:
Type Description
PIXI.Buffer the buffer requested.

getIndex ()PIXI.Buffer inherited

Geometry.js:178

returns the index buffer

Returns:
Type Description
PIXI.Buffer the index buffer.

interleave ()PIXI.Geometry inherited

Geometry.js:188

this function modifies the structure so that all current attributes become interleaved into a single buffer This can be useful if your model remains static as it offers a little performance boost

Returns:
Type Description
PIXI.Geometry returns self, useful for chaining.