Pixi’VNClass: BufferResource
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/buffer/BufferResource.d.ts:25
A resource that can be bound to a bind group and used in a shader. Whilst a buffer can be used as a resource, this class allows you to specify an offset and size of the buffer to use. This is useful if you have a large buffer and only part of it is used in a shader.
This resource, will listen for changes on the underlying buffer and emit a itself if the buffer changes shape.
Example
const buffer = new Buffer({
data: new Float32Array(1000),
usage: BufferUsage.UNIFORM,
});
// Create a buffer resource that uses the first 100 bytes of a buffer
const bufferResource = new BufferResource({
buffer,
offset: 0,
size: 100,
});
Advanced
Extends
EventEmitter<{change:BindResource; }>
Implements
Constructors
Constructor
> new BufferResource(options): BufferResource
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/buffer/BufferResource.d.ts:75
Create a new Buffer Resource.
Parameters
options
The options for the buffer resource
buffer
The underlying buffer that this resource is using
offset?
number
The offset of the buffer this resource is using. If not provided, then it will use the offset of the buffer.
size?
number
The size of the buffer this resource is using. If not provided, then it will use the size of the buffer.
Returns
BufferResource
Overrides
Properties
_bufferResource
> readonly _bufferResource: true = true
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/buffer/BufferResource.d.ts:60
Internal
A cheeky hint to the GL renderer to let it know this is a BufferResource
_resourceId
> _resourceId: number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/buffer/BufferResource.d.ts:49
Internal
the resource id used internally by the renderer to build bind group keys
Implementation of
BindResource._resourceId
_resourceType
> readonly _resourceType: "bufferResource" = "bufferResource"
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/buffer/BufferResource.d.ts:39
Internal
a resource type, used to identify how to handle it when its in a bind group / shader resource
Implementation of
BindResource._resourceType
_touched
> _touched: number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/buffer/BufferResource.d.ts:44
Internal
used internally to know if a uniform group was used in the last render pass
Implementation of
buffer
> buffer: Buffer
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/buffer/BufferResource.d.ts:51
the underlying buffer that this resource is using
destroyed
> readonly destroyed: boolean
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/buffer/BufferResource.d.ts:65
Has the Buffer resource been destroyed?
Implementation of
BindResource.destroyed
offset
> readonly offset: number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/buffer/BufferResource.d.ts:53
the offset of the buffer this resource is using. If not provided, then it will use the offset of the buffer.
size
> readonly size: number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/buffer/BufferResource.d.ts:55
the size of the buffer this resource is using. If not provided, then it will use the size of the buffer.
uid
> readonly uid: number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/buffer/BufferResource.d.ts:34
a unique id for this uniform group used through the renderer
prefixed
> static prefixed: string | boolean
Defined in: node_modules/eventemitter3/index.d.ts:9
Inherited from
Methods
addListener()
> addListener<T>(event, fn, context?): this
Defined in: node_modules/eventemitter3/index.d.ts:45
Type Parameters
T
T extends "change"
Parameters
event
T
fn
(...args) => void
context?
any
Returns
this
Inherited from
EventEmitter.addListener
destroy()
> destroy(destroyBuffer?): void
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/buffer/BufferResource.d.ts:86
Destroys this resource. Make sure the underlying buffer is not used anywhere else if you want to destroy it as well, or code will explode
Parameters
destroyBuffer?
boolean
Should the underlying buffer be destroyed as well?
Returns
void
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 "change"
Parameters
event
T
args
...ArgumentMap<{ change: BindResource; }>[Extract<T, "change">]
Returns
boolean
Inherited from
EventEmitter.emit
eventNames()
> eventNames(): "change"[]
Defined in: node_modules/eventemitter3/index.d.ts:15
Return an array listing the events for which the emitter has registered listeners.
Returns
"change"[]
Inherited from
EventEmitter.eventNames
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
"change"
Returns
number
Inherited from
EventEmitter.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 "change"
Parameters
event
T
Returns
(...args) => void[]
Inherited from
EventEmitter.listeners
off()
> off<T>(event, fn?, context?, once?): this
Defined in: node_modules/eventemitter3/index.d.ts:69
todo
Type Parameters
T
T extends "change"
Parameters
event
T
fn?
(...args) => void
context?
any
once?
boolean
Returns
this
Implementation of
Inherited from
EventEmitter.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 "change"
Parameters
event
T
fn
(...args) => void
context?
any
Returns
this
Implementation of
Inherited from
EventEmitter.on
onBufferChange()
> protected onBufferChange(): void
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/buffer/BufferResource.d.ts:80
Returns
void
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 "change"
Parameters
event
T
fn
(...args) => void
context?
any
Returns
this
Inherited from
EventEmitter.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?
"change"
Returns
this
Inherited from
EventEmitter.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 "change"
Parameters
event
T
fn?
(...args) => void
context?
any
once?
boolean
Returns
this
Inherited from
EventEmitter.removeListener