Documentation / device / VertexData

Class: VertexData

Defined in: libs/device/src/vertexdata.ts:29

The vertex data class

Constructors

Constructor

new VertexData(): VertexData

Defined in: libs/device/src/vertexdata.ts:38

Returns

VertexData

Accessors

vertexBuffers

Get Signature

get vertexBuffers(): VertexBufferInfo[]

Defined in: libs/device/src/vertexdata.ts:60

Vertex buffer information list

Returns

VertexBufferInfo[]

---

indexBuffer

Get Signature

get indexBuffer(): IndexBuffer<unknown>

Defined in: libs/device/src/vertexdata.ts:64

Index buffer

Returns

IndexBuffer<unknown>

---

numVertices

Get Signature

get numVertices(): number

Defined in: libs/device/src/vertexdata.ts:68

Number of vertices

Returns

number

Methods

clone()

clone(): VertexData

Defined in: libs/device/src/vertexdata.ts:51

Creates a new instance of VertexData by copying from this object

Returns

VertexData

New instance of VertexData

---

getDrawOffset()

getDrawOffset(): number

Defined in: libs/device/src/vertexdata.ts:72

Draw offset

Returns

number

---

setDrawOffset()

setDrawOffset(offset): void

Defined in: libs/device/src/vertexdata.ts:75

Parameters

offset

number

Returns

void

---

getVertexBuffer()

getVertexBuffer(semantic): StructuredBuffer<unknown>

Defined in: libs/device/src/vertexdata.ts:86

Gets the vertex buffer by specific vertex semantic

Parameters

semantic

VertexSemantic

The vertex semantic

Returns

StructuredBuffer<unknown>

Vertex buffer of the given semantic

---

getVertexBufferInfo()

getVertexBufferInfo(semantic): VertexBufferInfo

Defined in: libs/device/src/vertexdata.ts:94

Gets the vertex buffer information by specific vertex semantic

Parameters

semantic

VertexSemantic

The vertex semantic

Returns

VertexBufferInfo

Vertex buffer information of the given semantic

---

getIndexBuffer()

getIndexBuffer(): IndexBuffer<unknown>

Defined in: libs/device/src/vertexdata.ts:101

Gets the index buffer

Returns

IndexBuffer<unknown>

The index buffer

---

setVertexBuffer()

setVertexBuffer(buffer, stepMode?): StructuredBuffer<unknown>

Defined in: libs/device/src/vertexdata.ts:110

Sets a vertex buffer

Parameters

buffer

StructuredBuffer

The vertex buffer object

stepMode?

VertexStepMode

Step mode of the buffer

Returns

StructuredBuffer<unknown>

The buffer that was set

---

removeVertexBuffer()

removeVertexBuffer(buffer): boolean

Defined in: libs/device/src/vertexdata.ts:137

Removes a vertex buffer

Parameters

buffer

StructuredBuffer

Vertex buffer to be removed

Returns

boolean

true if the buffer was successfully removed, otherwise false

---

setIndexBuffer()

setIndexBuffer(buffer): IndexBuffer<unknown>

Defined in: libs/device/src/vertexdata.ts:157

Sets the index buffer

Parameters

buffer

IndexBuffer<unknown>

Index buffer to be set

Returns

IndexBuffer<unknown>

The index buffer that was set