Class: Buffer

Buffer

A wrapper for a WebGPU/WebGL Buffer. In PixiJS, the Buffer class is used to manage the data that is sent to the GPU rendering pipeline. It abstracts away the underlying GPU buffer and provides an interface for uploading typed arrays or other data to the GPU, They are used in the following places:

.1. Geometry as attribute data or index data for geometry
.2. UniformGroup as an underlying buffer for uniform data
.3. BufferResource as an underlying part of a buffer used directly by the GPU program

It is important to note that you must provide a usage type when creating a buffer. This is because the underlying GPU buffer needs to know how it will be used. For example, if you are creating a buffer to hold vertex data, you would use BufferUsage.VERTEX. This will tell the GPU that this buffer will be used as a vertex buffer. This is important because it will affect how you can use the buffer.

Buffers are updated by calling the Buffer.update method. This immediately updates the buffer on the GPU. Be mindful of calling this more often than you need to. It is recommended to update buffers only when needed.

In WebGPU, a GPU buffer cannot resized. This limitation is abstracted away, but know that resizing a buffer means creating a brand new one and destroying the old, so it is best to limit this if possible.

new Buffer (options)

ts:161

Creates a new Buffer with the given options

Name	Type	Description
`options`	BufferOptions	the options for the buffer

Example

const buffer = new Buffer({
    data: new Float32Array([1, 2, 3, 4]),
    usage: BufferUsage.VERTEX,
});

Extends

EventEmitter

Implements

BindResource

Members

data

the data in the buffer

destroyed boolean readonly

Has the buffer been destroyed?

Default Value:

false

shrinkToFit boolean

should the GPU buffer be shrunk when the data becomes smaller? changing this will cause the buffer to be destroyed and a new one created on the GPU this can be expensive, especially if the buffer is already big enough! setting this to false will prevent the buffer from being shrunk. This will yield better performance if you are constantly setting data that is changing size often.

Default Value:

true

static

whether the buffer is static or not

uid number readonly

a unique id for this uniform group used through the renderer

Methods

destroy ()

ts:295

Destroys the buffer

setDataWithSize (value, size, syncGPU)

ts:232

Sets the data in the buffer to the given value. This will immediately update the buffer on the GPU. If you only want to update a subset of the buffer, you can pass in the size of the data.

Name	Type	Description
`value`	TypedArray	the data to set
`size`	number	the size of the data in bytes
`syncGPU`	boolean	should the buffer be updated on the GPU immediately?

update (sizeInBytes) void

ts:280

updates the buffer on the GPU to reflect the data in the buffer. By default it will update the entire buffer. If you only want to update a subset of the buffer, you can pass in the size of the buffer to update.

Name	Type	Attributes	Description
`sizeInBytes`	number	<optional>	the new size of the buffer in bytes

Events

change

ts:81

emits when the underlying buffer has changed shape (i.e. resized) letting the renderer know that it needs to discard the old buffer on the GPU and create a new one

destroy

ts:93

emits when the buffer is destroyed. letting the renderer know that it needs to destroy the buffer on the GPU

update

ts:87

emits when the underlying buffer data has been updated. letting the renderer know that it needs to update the buffer on the GPU