Class: BatchGeometry

PIXI.BatchGeometry

Geometry used to batch standard PIXI content (e.g. Mesh, Sprite, Graphics objects).

new PIXI.BatchGeometry (_static) overrides

Name Type Attributes Default Description
_static boolean <optional>
false

Optimization flag, where false is updated every frame, true doesn't change frame-to-frame.

Extends

Members

_buffer PIXI.Buffer protected

Buffer used for position, color, texture IDs

_indexBuffer PIXI.Buffer protected

Index buffer data

Inherited Properties

From class PIXI.Geometry

glVertexArrayObjects object 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

instanced boolean inherited

Whether the geometry is instanced.

refCount number inherited

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

Inherited Methods

From class PIXI.Geometry

addAttribute (id, buffer, size, normalized, type, stride, start, instance) this inherited

Adds an attribute to the geometry Note: stride and start should be undefined if you dont know them, not 0!

Name Type Attributes Default Description
id string

the name of the attribute (matching up to a shader)

buffer PIXI.Buffer | number<Array>

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

size 0

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

normalized

should the data be normalized.

type PIXI.TYPES <optional>
PIXI.TYPES.FLOAT

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

stride number <optional>
0

How far apart, in bytes, the start of each value is. (used for interleaving data)

start number <optional>
0

How far into the array to start reading values (used for interleaving data)

instance

Instancing flag

Returns:
Type Description
this
  • Returns self, useful for chaining.

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 Attributes Description
buffer PIXI.Buffer | number<Array> <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.

Returns a clone of the geometry.

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

destroy () void inherited

Destroys the geometry.

dispose () void inherited

Disposes WebGL resources that are connected to this geometry.

Returns the requested attribute.

Name Type Description
id string

The name of the attribute required

Returns:
Type Description
PIXI.Attribute
  • The attribute requested.

Returns the requested buffer.

Name Type Description
id string

The name of the buffer required.

Returns:
Type Description
PIXI.Buffer
  • The buffer requested.

Returns the index buffer

Returns:
Type Description
PIXI.Buffer
  • The index buffer.

getSize () number inherited

Get the size of the geometries, in vertices.

Returns:
Type Description
number

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.