Pixi’VNClass: BatchGeometry
Defined in: node_modules/pixi.js/lib/rendering/batcher/shared/BatchGeometry.d.ts:8
This class represents a geometry used for batching in the rendering system. It defines the structure of vertex attributes and index buffers for batched rendering.
Advanced
Extends
Constructors
Constructor
> new BatchGeometry(): BatchGeometry
Defined in: node_modules/pixi.js/lib/rendering/batcher/shared/BatchGeometry.d.ts:9
Returns
BatchGeometry
Overrides
Properties
_gcData?
> optional _gcData?: GCData
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:117
Internal
Inherited from
_gcLastUsed
> _gcLastUsed: number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:121
Internal
Inherited from
_gpuData
> _gpuData: Record<number, GlGeometryGpuData>
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:115
Internal
Inherited from
_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
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
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
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
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
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
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
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
prefixed
> static prefixed: string | boolean
Defined in: node_modules/eventemitter3/index.d.ts:9
Inherited from
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
Inherited from
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
The attribute option to add.
Returns
void
Inherited from
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
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
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
- The attribute requested.
Inherited from
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
- The buffer requested.
Inherited from
getIndex()
> getIndex(): Buffer
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/geometry/Geometry.d.ts:158
Returns the index buffer
Returns
- The index buffer.
Inherited from
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
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
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