@orillusion/core

---

Class: VertexGPUBuffer

Defined in: src/gfx/graphics/webGpu/core/buffer/VertexGPUBuffer.ts:11

The buffer use at geometry indices written in the computer shader or CPU Coder usage GPUBufferUsage.STORAGE | GPUBufferUsage.COPY_DST | GPUBufferUsage.VERTEX

Constructors

Constructor

new VertexGPUBuffer(size): VertexGPUBuffer

Defined in: src/gfx/graphics/webGpu/core/buffer/VertexGPUBuffer.ts:13

Parameters

size

number

Returns

VertexGPUBuffer

Overrides

GPUBufferBase.constructor

Properties

bufferType

bufferType: GPUBufferType

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:31

Inherited from

GPUBufferBase.bufferType

---

memory

memory: MemoryDO

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:32

Inherited from

GPUBufferBase.memory

---

memoryNodes

memoryNodes: Map<string | number, MemoryInfo>

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:33

Inherited from

GPUBufferBase.memoryNodes

---

seek

seek: number

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:34

Inherited from

GPUBufferBase.seek

---

outFloat32Array

outFloat32Array: Float32Array

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:35

Inherited from

GPUBufferBase.outFloat32Array

---

byteSize

byteSize: number

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:36

Inherited from

GPUBufferBase.byteSize

---

usage

usage: number

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:37

Inherited from

GPUBufferBase.usage

---

visibility

visibility: number

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:38

Inherited from

GPUBufferBase.visibility

---

_boundCtx

_boundCtx: Context3D = null

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:44

The Context3D this buffer is bound to. Set on first GPU use via bindCtx.

Inherited from

GPUBufferBase._boundCtx

---

node

node: MemoryInfo

Defined in: src/gfx/graphics/webGpu/core/buffer/VertexGPUBuffer.ts:12

Accessors

buffer

Get Signature

get buffer(): GPUBuffer

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:71

Return the GPU buffer. Materializes lazily on first access. Callers must have bound this buffer to a Context3D via bindCtx() before touching .buffer.

Returns

GPUBuffer

Inherited from

GPUBufferBase.buffer

Methods

debug()

debug(): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:104

Returns

void

Inherited from

GPUBufferBase.debug

---

reset()

reset(clean?, size?, data?): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:107

Parameters

clean?

boolean = false

size?

number = 0

data?

Float32Array

Returns

void

Inherited from

GPUBufferBase.reset

---

setBoolean()

setBoolean(name, v): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:115

Parameters

name

string

v

boolean

Returns

void

Inherited from

GPUBufferBase.setBoolean

---

readBoole()

readBoole(name): boolean

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:125

Parameters

name

string

Returns

boolean

Inherited from

GPUBufferBase.readBoole

---

setFloat()

setFloat(name, v): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:133

Parameters

name

string

v

number

Returns

void

Inherited from

GPUBufferBase.setFloat

---

getFloat()

getFloat(name): number

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:142

Parameters

name

string

Returns

number

Inherited from

GPUBufferBase.getFloat

---

setInt8()

setInt8(name, v): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:150

Parameters

name

string

v

number

Returns

void

Inherited from

GPUBufferBase.setInt8

---

getInt8()

getInt8(name): number

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:159

Parameters

name

string

Returns

number

Inherited from

GPUBufferBase.getInt8

---

setInt16()

setInt16(name, v): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:167

Parameters

name

string

v

number

Returns

void

Inherited from

GPUBufferBase.setInt16

---

getInt16()

getInt16(name): number

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:176

Parameters

name

string

Returns

number

Inherited from

GPUBufferBase.getInt16

---

setInt32()

setInt32(name, v): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:184

Parameters

name

string

v

number

Returns

void

Inherited from

GPUBufferBase.setInt32

---

getInt32()

getInt32(name): number

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:193

Parameters

name

string

Returns

number

Inherited from

GPUBufferBase.getInt32

---

setUint8()

setUint8(name, v): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:201

Parameters

name

string

v

number

Returns

void

Inherited from

GPUBufferBase.setUint8

---

getUint8()

getUint8(name): number

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:210

Parameters

name

string

Returns

number

Inherited from

GPUBufferBase.getUint8

---

setUint16()

setUint16(name, v): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:219

Parameters

name

string

v

number

Returns

void

Inherited from

GPUBufferBase.setUint16

---

getUint16()

getUint16(name): number

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:228

Parameters

name

string

Returns

number

Inherited from

GPUBufferBase.getUint16

---

setUint32()

setUint32(name, v): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:236

Parameters

name

string

v

number

Returns

void

Inherited from

GPUBufferBase.setUint32

---

getUint32()

getUint32(name): number

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:245

Parameters

name

string

Returns

number

Inherited from

GPUBufferBase.getUint32

---

setVector2()

setVector2(name, v2): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:253

Parameters

name

string

v2

Vector2

Returns

void

Inherited from

GPUBufferBase.setVector2

---

getVector2()

getVector2(name): Vector2

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:262

Parameters

name

string

Returns

Vector2

Inherited from

GPUBufferBase.getVector2

---

setVector3()

setVector3(name, v3): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:270

Parameters

name

string

v3

Vector3

Returns

void

Inherited from

GPUBufferBase.setVector3

---

getVector3()

getVector3(name): Vector3

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:279

Parameters

name

string

Returns

Vector3

Inherited from

GPUBufferBase.getVector3

---

setVector4()

setVector4(name, v4): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:287

Parameters

name

string

v4

Quaternion | Vector4

Returns

void

Inherited from

GPUBufferBase.setVector4

---

getVector4()

getVector4(name): Vector4

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:296

Parameters

name

string

Returns

Vector4

Inherited from

GPUBufferBase.getVector4

---

setVector4Array()

setVector4Array(name, v4Array): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:304

Parameters

name

string

v4Array

Vector3[] | Vector4[] | Quaternion[]

Returns

void

Inherited from

GPUBufferBase.setVector4Array

---

setColor()

setColor(name, color): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:313

Parameters

name

string

color

Color

Returns

void

Inherited from

GPUBufferBase.setColor

---

getColor()

getColor(name): Color

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:322

Parameters

name

string

Returns

Color

Inherited from

GPUBufferBase.getColor

---

setColorArray()

setColorArray(name, colorArray): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:330

Parameters

name

string

colorArray

Color[]

Returns

void

Inherited from

GPUBufferBase.setColorArray

---

setMatrix()

setMatrix(name, mat): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:339

Parameters

name

string

mat

Matrix4

Returns

void

Inherited from

GPUBufferBase.setMatrix

---

setMatrixArray()

setMatrixArray(name, mats): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:349

Parameters

name

string

mats

Matrix4[]

Returns

void

Inherited from

GPUBufferBase.setMatrixArray

---

setArray()

setArray(name, data): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:361

Parameters

name

string

data

number[]

Returns

void

Inherited from

GPUBufferBase.setArray

---

setFloat32Array()

setFloat32Array(name, data): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:370

Parameters

name

string

data

Float32Array

Returns

void

Inherited from

GPUBufferBase.setFloat32Array

---

setInt32Array()

setInt32Array(name, data): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:379

Parameters

name

string

data

Int32Array

Returns

void

Inherited from

GPUBufferBase.setInt32Array

---

setUint32Array()

setUint32Array(name, data): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:389

Parameters

name

string

data

Uint32Array

Returns

void

Inherited from

GPUBufferBase.setUint32Array

---

allocMemoryNode()

allocMemoryNode(name, byteSize): MemoryInfo

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:398

Parameters

name

string

byteSize

number

Returns

MemoryInfo

Inherited from

GPUBufferBase.allocMemoryNode

---

getMemoryNode()

getMemoryNode(name): MemoryInfo

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:407

Parameters

name

string

Returns

MemoryInfo

Inherited from

GPUBufferBase.getMemoryNode

---

setStruct()

setStruct<T>(c, index, data, property?): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:411

Type Parameters

T

T extends Struct

Parameters

c

() => T

index

number

data

any

property?

string

Returns

void

Inherited from

GPUBufferBase.setStruct

---

setStructArray()

setStructArray<T>(c, dataList, property?): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:470

Type Parameters

T

T extends Struct

Parameters

c

() => T

dataList

any[]

property?

string

Returns

void

Inherited from

GPUBufferBase.setStructArray

---

clean()

clean(): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:478

Returns

void

Inherited from

GPUBufferBase.clean

---

apply()

apply(ctx?): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:489

Upload CPU-side memory to the GPU buffer. Lazy-materializes when a Context3D is available. If called with no ctx and the buffer is not yet bound, the upload is DEFERRED: CPU data remains in shareDataBuffer and flows to the GPU automatically when .buffer is first accessed with a real ctx (via _materialize).

Parameters

ctx?

Context3D

Returns

void

Inherited from

GPUBufferBase.apply

---

mapAsyncWrite()

mapAsyncWrite(floatArray, len): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:502

Parameters

floatArray

FloatArray

len

number

Returns

void

Inherited from

GPUBufferBase.mapAsyncWrite

---

destroy()

destroy(): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:554

Returns

void

Inherited from

GPUBufferBase.destroy

---

resizeBuffer()

resizeBuffer(size, data?): void

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:603

Parameters

size

number

data?

ArrayBufferData

Returns

void

Inherited from

GPUBufferBase.resizeBuffer

---

readBuffer()

Call Signature

readBuffer(): Float32Array

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:645

Returns

Float32Array

Inherited from

GPUBufferBase.readBuffer

Call Signature

readBuffer(promise): Float32Array

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:646

Parameters

promise

false

Returns

Float32Array

Inherited from

GPUBufferBase.readBuffer

Call Signature

readBuffer(promise): Promise<Float32Array<ArrayBufferLike>>

Defined in: src/gfx/graphics/webGpu/core/buffer/GPUBufferBase.ts:647

Parameters

promise

true

Returns

Promise<Float32Array<ArrayBufferLike>>

Inherited from

GPUBufferBase.readBuffer