Class: MeshGeometry

Defined in: node_modules/pixi.js/lib/scene/mesh/shared/MeshGeometry.d.ts:26

A geometry used to batch multiple meshes with the same texture.

Advanced

Extends

• Geometry

Extended by

• PlaneGeometry
• RopeGeometry
• QuadGeometry

Constructors

Constructor

> new MeshGeometry(options): MeshGeometry

Defined in: node_modules/pixi.js/lib/scene/mesh/shared/MeshGeometry.d.ts:32

Parameters

options

MeshGeometryOptions

The options of the mesh geometry.

Returns

MeshGeometry

Overrides

Geometry.constructor

Constructor

> new MeshGeometry(positions, uvs, indices): MeshGeometry

Defined in: node_modules/pixi.js/lib/scene/mesh/shared/MeshGeometry.d.ts:34

Parameters

positions

Float32Array

uvs

Float32Array

indices

Uint32Array

Returns

MeshGeometry

Deprecated

since 8.0.0

Overrides

Geometry.constructor

Properties

_gcData?

> optional _gcData?: GCData

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:117

Internal

Inherited from

Geometry._gcData

---

_gcLastUsed

> _gcLastUsed: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:121

Internal

Inherited from

Geometry._gcLastUsed

---

_gpuData

> _gpuData: Record<number, GlGeometryGpuData>

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:115

Internal

Inherited from

Geometry._gpuData

---

_layoutKey

> _layoutKey: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:137

Internal

the layout key will be generated by WebGPU all geometries that have the same structure will have the same layout key. This is used to cache the pipeline layout

Inherited from

Geometry._layoutKey

---

attributes

> readonly attributes: Record<string, Attribute>

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:127

A record of the attributes of the geometry.

Inherited from

Geometry.attributes

---

autoGarbageCollect

> autoGarbageCollect: boolean

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:119

If set to true, the resource will be garbage collected automatically when it is not used.

Inherited from

Geometry.autoGarbageCollect

---

batchMode

> batchMode: BatchMode

Defined in: node_modules/pixi.js/lib/scene/mesh/shared/MeshGeometry.d.ts:28

---

buffers

> readonly buffers: Buffer[]

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:129

The buffers that the attributes use

Inherited from

Geometry.buffers

---

indexBuffer

> indexBuffer: Buffer

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:131

The index buffer of the geometry

Inherited from

Geometry.indexBuffer

---

instanceCount

> instanceCount: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:139

the instance count of the geometry to draw

Inherited from

Geometry.instanceCount

---

topology

> topology: Topology

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:123

The topology of the geometry.

Inherited from

Geometry.topology

---

uid

> readonly uid: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:125

The unique id of the geometry.

Inherited from

Geometry.uid

---

defaultOptions

> static defaultOptions: MeshGeometryOptions

Defined in: node_modules/pixi.js/lib/scene/mesh/shared/MeshGeometry.d.ts:27

---

prefixed

> static prefixed: string | boolean

Defined in: node_modules/eventemitter3/index.d.ts:9

Inherited from

Geometry.prefixed

Accessors

bounds

Get Signature

> get bounds(): Bounds

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:182

Returns the bounds of the geometry.

Returns

Bounds

Inherited from

Geometry.bounds

---

indices

Get Signature

> get indices(): Uint32Array

Defined in: node_modules/pixi.js/lib/scene/mesh/shared/MeshGeometry.d.ts:54

The indices of the mesh.

Returns

Uint32Array

Set Signature

> set indices(value): void

Defined in: node_modules/pixi.js/lib/scene/mesh/shared/MeshGeometry.d.ts:55

Parameters

value

Uint32Array

Returns

void

---

positions

Get Signature

> get positions(): Float32Array

Defined in: node_modules/pixi.js/lib/scene/mesh/shared/MeshGeometry.d.ts:36

The positions of the mesh.

Returns

Float32Array

Set Signature

> set positions(value): void

Defined in: node_modules/pixi.js/lib/scene/mesh/shared/MeshGeometry.d.ts:43

Set the positions of the mesh. When setting the positions, its important that the uvs array is at least as long as the positions array. otherwise the geometry will not be valid.

Parameters

value

Float32Array

The positions of the mesh.

Returns

void

---

uvs

Get Signature

> get uvs(): Float32Array

Defined in: node_modules/pixi.js/lib/scene/mesh/shared/MeshGeometry.d.ts:45

The UVs of the mesh.

Returns

Float32Array

Set Signature

> set uvs(value): void

Defined in: node_modules/pixi.js/lib/scene/mesh/shared/MeshGeometry.d.ts:52

Set the UVs of the mesh. Its important that the uvs array you set is at least as long as the positions array. otherwise the geometry will not be valid.

Parameters

value

Float32Array

The UVs of the mesh.

Returns

void

Methods

addAttribute()

> addAttribute(name, attributeOption): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:175

Adds an attribute to the geometry.

Parameters

name

string

The name of the attribute to add.

attributeOption

AttributeOption

The attribute option to add.

Returns

void

Inherited from

Geometry.addAttribute

---

addIndex()

> addIndex(indexBuffer): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:180

Adds an index buffer to the geometry.

Parameters

indexBuffer

number[] | Buffer | TypedArray

The index buffer to add. Can be a Buffer, TypedArray, or an array of numbers.

Returns

void

Inherited from

Geometry.addIndex

---

addListener()

> addListener<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:45

Type Parameters

T

T extends "update" | "destroy" | "unload"

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

Geometry.addListener

---

destroy()

> destroy(destroyBuffers?): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:189

destroys the geometry.

Parameters

destroyBuffers?

boolean

destroy the buffers associated with this geometry

Returns

void

Inherited from

Geometry.destroy

---

emit()

> emit<T>(event, ...args): boolean

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

Type Parameters

T

T extends "update" | "destroy" | "unload"

Parameters

event

T

args

...ArgumentMap<{ destroy: Geometry; unload: Geometry; update: Geometry; }>[Extract<T, "update" | "destroy" | "unload">]

Returns

boolean

Inherited from

Geometry.emit

---

eventNames()

> eventNames(): ("update" | "destroy" | "unload")[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered listeners.

Returns

("update" | "destroy" | "unload")[]

Inherited from

Geometry.eventNames

---

getAttribute()

> getAttribute(id): Attribute

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:153

Returns the requested attribute.

Parameters

id

string

The name of the attribute required

Returns

Attribute

• The attribute requested.

Inherited from

Geometry.getAttribute

---

getBuffer()

> getBuffer(id): Buffer

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:164

Returns the requested buffer.

Parameters

id

string

The name of the buffer required.

Returns

Buffer

• The buffer requested.

Inherited from

Geometry.getBuffer

---

getIndex()

> getIndex(): Buffer

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:158

Returns the index buffer

Returns

Buffer

• The index buffer.

Inherited from

Geometry.getIndex

---

getSize()

> getSize(): number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:169

Used to figure out how many vertices there are in this geometry

Returns

number

the number of vertices in the geometry

Inherited from

Geometry.getSize

---

listenerCount()

> listenerCount(event): number

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

Parameters

event

"update" | "destroy" | "unload"

Returns

number

Inherited from

Geometry.listenerCount

---

listeners()

> listeners<T>(event): (...args) => void[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

Type Parameters

T

T extends "update" | "destroy" | "unload"

Parameters

event

T

Returns

(...args) => void[]

Inherited from

Geometry.listeners

---

off()

> off<T>(event, fn?, context?, once?): this

Defined in: node_modules/eventemitter3/index.d.ts:69

Type Parameters

T

T extends "update" | "destroy" | "unload"

Parameters

event

T

fn?

(...args) => void

context?

any

once?

boolean

Returns

this

Inherited from

Geometry.off

---

on()

> on<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

Type Parameters

T

T extends "update" | "destroy" | "unload"

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

Geometry.on

---

onBufferUpdate()

> protected onBufferUpdate(): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:147

Returns

void

Inherited from

Geometry.onBufferUpdate

---

once()

> once<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

Type Parameters

T

T extends "update" | "destroy" | "unload"

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

Geometry.once

---

removeAllListeners()

> removeAllListeners(event?): this

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

Parameters

event?

"update" | "destroy" | "unload"

Returns

this

Inherited from

Geometry.removeAllListeners

---

removeListener()

> removeListener<T>(event, fn?, context?, once?): this

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

Type Parameters

T

T extends "update" | "destroy" | "unload"

Parameters

event

T

fn?

(...args) => void

context?

any

once?

boolean

Returns

this

Inherited from

Geometry.removeListener

---

unload()

> unload(): void

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:184

Unloads the geometry from the GPU.

Returns

void

Inherited from

Geometry.unload