Documentation / device / StructuredBuffer

Interface: StructuredBuffer<T>

Defined in: libs/device/src/gpuobject.ts:1475

Abstract interface for structured buffer

Extends

• GPUDataBuffer<T>

Type Parameters

T

T = unknown

Properties

[EventMapType]?

readonly optional [EventMapType]?: object

Defined in: libs/base/dist/index.d.ts:549

Type-only event map marker.

dispose

dispose: []

Inherited from

GPUDataBuffer.[EventMapType]

---

device

readonly device: AbstractDevice

Defined in: libs/device/src/gpuobject.ts:1262

The object was created by which device

Inherited from

GPUDataBuffer.device

---

object

readonly object: T

Defined in: libs/device/src/gpuobject.ts:1264

The internal GPU object

Inherited from

GPUDataBuffer.object

---

uid

readonly uid: number

Defined in: libs/device/src/gpuobject.ts:1266

unique id

Inherited from

GPUDataBuffer.uid

---

cid

readonly cid: number

Defined in: libs/device/src/gpuobject.ts:1267

Inherited from

GPUDataBuffer.cid

---

disposed

readonly disposed: boolean

Defined in: libs/device/src/gpuobject.ts:1268

Inherited from

GPUDataBuffer.disposed

---

name

name: string

Defined in: libs/device/src/gpuobject.ts:1269

Inherited from

GPUDataBuffer.name

---

restoreHandler

restoreHandler: (tex) => void

Defined in: libs/device/src/gpuobject.ts:1270

Parameters

tex

GPUObject

Returns

void

Inherited from

GPUDataBuffer.restoreHandler

---

byteLength

readonly byteLength: number

Defined in: libs/device/src/gpuobject.ts:1452

Inherited from

GPUDataBuffer.byteLength

---

usage

readonly usage: number

Defined in: libs/device/src/gpuobject.ts:1453

Inherited from

GPUDataBuffer.usage

---

structure

structure: Immutable<PBStructTypeInfo>

Defined in: libs/device/src/gpuobject.ts:1476

Methods

on()

on<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:556

Sets up a function that will be called whenever the specified event is delivered to the target

Type Parameters

K

K extends "dispose"

Parameters

type

K

The event type to listen for

listener

EventListener<{ dispose: []; }, K>

The callback function

context?

unknown

Context object of the listener function

Returns

void

Inherited from

GPUDataBuffer.on

---

once()

once<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:563

Sets up a function that will be called only once when the specified event is delivered to the target

Type Parameters

K

K extends "dispose"

Parameters

type

K

The event type to listen for

listener

EventListener<{ dispose: []; }, K>

The callback function

context?

unknown

Context object of the listener function

Returns

void

Inherited from

GPUDataBuffer.once

---

off()

off<K>(type, listener?, context?): void

Defined in: libs/base/dist/index.d.ts:569

Removes an event listener function previously registered.

Type Parameters

K

K extends "dispose"

Parameters

type

K

The event type for which to remove an event listener

listener?

EventListener<{ dispose: []; }>

The callback function to be removed

context?

unknown

Returns

void

Inherited from

GPUDataBuffer.off

---

dispatchEvent()

dispatchEvent<K>(type, ...args): void

Defined in: libs/base/dist/index.d.ts:575

Synchronously invoke the affected event listeners with an event object

Type Parameters

K

K extends "dispose"

Parameters

type

K

args

...object[K]

Returns

void

false if the event was canceled, otherwise true

Inherited from

GPUDataBuffer.dispatchEvent

---

isVertexLayout()

isVertexLayout(): this is VertexLayout<unknown>

Defined in: libs/device/src/gpuobject.ts:1271

Returns

this is VertexLayout<unknown>

Inherited from

GPUDataBuffer.isVertexLayout

---

isFramebuffer()

isFramebuffer(): this is FrameBuffer<unknown>

Defined in: libs/device/src/gpuobject.ts:1272

Returns

this is FrameBuffer<unknown>

Inherited from

GPUDataBuffer.isFramebuffer

---

isSampler()

isSampler(): this is TextureSampler<unknown>

Defined in: libs/device/src/gpuobject.ts:1273

Returns

this is TextureSampler<unknown>

Inherited from

GPUDataBuffer.isSampler

---

isTexture()

isTexture(): this is BaseTexture<unknown>

Defined in: libs/device/src/gpuobject.ts:1274

Returns

this is BaseTexture<unknown>

Inherited from

GPUDataBuffer.isTexture

---

isTexture2D()

isTexture2D(): this is Texture2D<unknown>

Defined in: libs/device/src/gpuobject.ts:1275

Returns

this is Texture2D<unknown>

Inherited from

GPUDataBuffer.isTexture2D

---

isTexture2DArray()

isTexture2DArray(): this is Texture2DArray<unknown>

Defined in: libs/device/src/gpuobject.ts:1276

Returns

this is Texture2DArray<unknown>

Inherited from

GPUDataBuffer.isTexture2DArray

---

isTexture3D()

isTexture3D(): this is Texture3D<unknown>

Defined in: libs/device/src/gpuobject.ts:1277

Returns

this is Texture3D<unknown>

Inherited from

GPUDataBuffer.isTexture3D

---

isTextureCube()

isTextureCube(): this is TextureCube<unknown>

Defined in: libs/device/src/gpuobject.ts:1278

Returns

this is TextureCube<unknown>

Inherited from

GPUDataBuffer.isTextureCube

---

isTextureVideo()

isTextureVideo(): this is TextureVideo<unknown>

Defined in: libs/device/src/gpuobject.ts:1279

Returns

this is TextureVideo<unknown>

Inherited from

GPUDataBuffer.isTextureVideo

---

isProgram()

isProgram(): this is GPUProgram<unknown>

Defined in: libs/device/src/gpuobject.ts:1280

Returns

this is GPUProgram<unknown>

Inherited from

GPUDataBuffer.isProgram

---

isBuffer()

isBuffer(): this is GPUDataBuffer<unknown>

Defined in: libs/device/src/gpuobject.ts:1281

Returns

this is GPUDataBuffer<unknown>

Inherited from

GPUDataBuffer.isBuffer

---

isBindGroup()

isBindGroup(): this is BindGroup

Defined in: libs/device/src/gpuobject.ts:1282

Returns

this is BindGroup

Inherited from

GPUDataBuffer.isBindGroup

---

dispose()

dispose(): void

Defined in: libs/device/src/gpuobject.ts:1283

Returns

void

Inherited from

GPUDataBuffer.dispose

---

reload()

reload(): void

Defined in: libs/device/src/gpuobject.ts:1284

Returns

void

Inherited from

GPUDataBuffer.reload

---

destroy()

destroy(): void

Defined in: libs/device/src/gpuobject.ts:1285

Returns

void

Inherited from

GPUDataBuffer.destroy

---

restore()

restore(): void

Defined in: libs/device/src/gpuobject.ts:1286

Returns

void

Inherited from

GPUDataBuffer.restore

---

bufferSubData()

bufferSubData(dstByteOffset, data, srcOffset?, srcLength?): void

Defined in: libs/device/src/gpuobject.ts:1454

Parameters

dstByteOffset

number

data

TypedArray

srcOffset?

number

srcLength?

number

Returns

void

Inherited from

GPUDataBuffer.bufferSubData

---

getBufferSubData()

getBufferSubData(dstBuffer?, offsetInBytes?, sizeInBytes?): Promise<Uint8Array<ArrayBuffer>>

Defined in: libs/device/src/gpuobject.ts:1455

Parameters

dstBuffer?

Uint8Array<ArrayBuffer>

offsetInBytes?

number

sizeInBytes?

number

Returns

Promise<Uint8Array<ArrayBuffer>>

Inherited from

GPUDataBuffer.getBufferSubData

---

set()

set(name, value): void

Defined in: libs/device/src/gpuobject.ts:1477

Parameters

name

string

value

StructuredValue

Returns

void