Class IndexedGeometry

Used to create an IndexedGeometry which holds an index array to use as an index buffer.

The index array represents the order in which the attributes should be processed. This allows to create smaller vertex, uv and normal arrays.

During the render, the IndexedGeometry is responsible for setting the vertexBuffers and drawing the indexed vertices.

Example

const vertices = new Float32Array([
  -1, -1,  0,
   1, -1,  0,
  -1,  1,  0,
   1,  1,  0
])

// vertices index (order in which they should be drawn)
const indexArray = new Uint16Array([0, 2, 1, 1, 2, 3])

// create an indexed quad geometry made of 4 vertices
const indexedGeometry = new IndexedGeometry()

indexedGeometry.setAttribute({
  name: 'position',
  type: 'vec3f',
  bufferFormat: 'float32x3',
  size: 3,
  bufferLength: vertices.length,
  array: vertices,
})

indexedGeometry.setIndexBuffer({
  array: indexArray,
  bufferFormat: 'uint16',
})

Hierarchy (view full)

Geometry
- IndexedGeometry

Constructors

constructor

new IndexedGeometry(parameters?): IndexedGeometry
IndexedGeometry constructor
Parameters
- parameters: Partial<GeometryOptions> = {}
  parameters used to create our IndexedGeometry
Returns IndexedGeometry
Overrides Geometry.constructor
- Defined in src/core/geometries/IndexedGeometry.ts:75

Properties

verticesCount

verticesCount: number

Number of vertices defined by this geometry

verticesOrder

verticesOrder: GPUFrontFace

Vertices order to be drawn by the render pipeline

topology

topology: GPUPrimitiveTopology

Topology to use with this Geometry, i.e. whether to draw triangles or points

instancesCount

instancesCount: number

Number of instances of this geometry to draw

vertexBuffers

vertexBuffers: VertexBuffer[]

Array of vertex buffers to use with this geometry

options

options: GeometryOptions

Options used to create this geometry

type

type: string

The type of the geometry

uuid

uuid: string

The universal unique id of the geometry

indirectDraw

indirectDraw: IndirectDrawParams

Allow to draw this Geometry with an IndirectBuffer if set.

boundingBox

boundingBox: Box3

The bounding box of the geometry, i.e. two Vec3 defining the min and max positions to wrap this geometry in a cube

wgslStructFragment

wgslStructFragment: string

A string to append to our shaders code describing the WGSL structure representing this geometry attributes

layoutCacheKey

layoutCacheKey: string

A string representing the vertexBuffers layout, used for pipelines caching

consumers

consumers: Set<string>

A Set to store this Geometry consumers (Mesh uuid)

ready

ready: boolean

Whether this geometry is ready to be drawn, i.e. it has been computed and all its vertex buffers have been created

indexBuffer

indexBuffer: IndexBuffer

Object containing our index buffer format & length, array and GPUBuffer

Accessors

shouldCompute

get shouldCompute(): boolean
Get whether this Geometry is ready to compute, i.e. if its first vertex buffer array has not been created yet

Returns boolean
Inherited from Geometry.shouldCompute
- Defined in src/core/geometries/Geometry.ts:330

useUint16IndexArray

get useUint16IndexArray(): boolean
If we have less than 65.536 vertices, we should use a Uin16Array to hold our index buffer values

Returns boolean
- Defined in src/core/geometries/IndexedGeometry.ts:120

Methods

addVertexBuffer

addVertexBuffer(parameters?): VertexBuffer
Add a vertex buffer to our Geometry, set its attributes and return it
Parameters
- parameters: VertexBufferParams = {}
  vertex buffer parameters
Returns VertexBuffer
- newly created vertex buffer
Inherited from Geometry.addVertexBuffer
- Defined in src/core/geometries/Geometry.ts:198

getVertexBufferByName

getVertexBufferByName(name?): VertexBuffer
Get a vertex buffer by name
Parameters
- name: string = ''
  our vertex buffer name
Returns VertexBuffer
- found vertex buffer or null if not found
Inherited from Geometry.getVertexBufferByName
- Defined in src/core/geometries/Geometry.ts:239

setAttribute

setAttribute(parameters): void
Set a vertex buffer attribute
Parameters
- parameters: VertexBufferAttributeParams
  attributes parameters
Returns void
Inherited from Geometry.setAttribute
- Defined in src/core/geometries/Geometry.ts:247

getAttributeByName

getAttributeByName(name): VertexBufferAttribute
Get an attribute by name
Parameters
- name: string
  name of the attribute to find
Returns VertexBufferAttribute
- found attribute or null if not found
Inherited from Geometry.getAttributeByName
- Defined in src/core/geometries/Geometry.ts:339

computeGeometry

computeGeometry(): void
Compute a Geometry, which means iterate through all vertex buffers and create the attributes array that will be sent as buffers. Also compute the Geometry bounding box.

Returns void
Inherited from Geometry.computeGeometry
- Defined in src/core/geometries/Geometry.ts:354

setWGSLFragment

setWGSLFragment(): void
Set the WGSL code snippet that will be appended to the vertex shader.

Returns void
Inherited from Geometry.setWGSLFragment
- Defined in src/core/geometries/Geometry.ts:426

uploadBuffer

uploadBuffer(renderer, buffer): void
Upload a GeometryBuffer to the GPU.
Parameters
- renderer: Renderer
  Renderer used to upload the buffer.
- buffer: GeometryBuffer
  GeometryBuffer holding a Buffer and a typed array to upload.
Returns void
Inherited from Geometry.uploadBuffer
- Defined in src/core/geometries/Geometry.ts:489

useIndirectBuffer

useIndirectBuffer(parameters): void
Set the indirectDraw parameters to draw this Geometry with an IndirectBuffer.
Parameters
- parameters: IndirectDrawParams
  indirect draw parameters to use for this Geometry.
Returns void
Inherited from Geometry.useIndirectBuffer
- Defined in src/core/geometries/Geometry.ts:505

render

render(pass): void
Set our vertex buffers then draw the geometry.
Parameters
- pass: GPURenderPassTypes
  current render pass.
Returns void
Inherited from Geometry.render
- Defined in src/core/geometries/Geometry.ts:540

loseContext

loseContext(): void
Reset all the vertex buffers and index buffer when the device is lost

Returns void
Overrides Geometry.loseContext
- Defined in src/core/geometries/IndexedGeometry.ts:90

restoreContext

restoreContext(renderer): void
Restore the IndexedGeometry buffers on context restoration
Parameters
- renderer: Renderer
  The Renderer used to recreate the buffers
Returns void
Overrides Geometry.restoreContext
- Defined in src/core/geometries/IndexedGeometry.ts:102

setIndexBuffer

setIndexBuffer(parameters): void
Set our indexBuffer
Parameters
- parameters: IndexedGeometryIndexBufferOptions
  parameters used to create our index buffer
Returns void
- Defined in src/core/geometries/IndexedGeometry.ts:128

createBuffers

createBuffers(parameters): void
Create the Geometry vertex buffers and index buffer.
Parameters
- parameters: {
  renderer: Renderer;
  label?: string;
  }
  parameters used to create the vertex buffers.
  - renderer: Renderer
    Renderer used to create the vertex buffers.
  - Optional label?: string
    label to use for the vertex buffers.
Returns void
Overrides Geometry.createBuffers
- Defined in src/core/geometries/IndexedGeometry.ts:154

setGeometryBuffers

setGeometryBuffers(pass): void
First, set our render pass geometry vertex buffers Then, set our render pass geometry index buffer
Parameters
- pass: GPURenderPassTypes
  current render pass
Returns void
Overrides Geometry.setGeometryBuffers
- Defined in src/core/geometries/IndexedGeometry.ts:178

drawGeometry

drawGeometry(pass): void
Draw our indexed geometry. Can use indirect drawing if indirectDraw is set up.
Parameters
- pass: GPURenderPassTypes
  current render pass.
Returns void
Overrides Geometry.drawGeometry
- Defined in src/core/geometries/IndexedGeometry.ts:193

destroy

destroy(renderer?): void
Destroy our indexed geometry vertex buffers and index buffer.
Parameters
- renderer: Renderer = null
  current Renderer, in case we want to remove the buffer from the cache.
Returns void
Overrides Geometry.destroy
- Defined in src/core/geometries/IndexedGeometry.ts:205

Class IndexedGeometry

Example

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

parameters: Partial<GeometryOptions> = {}

Returns IndexedGeometry

Properties

verticesCount

verticesOrder

topology

instancesCount

vertexBuffers

options

type

uuid

indirectDraw

boundingBox

wgslStructFragment

layoutCacheKey

consumers

ready

indexBuffer

Accessors

shouldCompute

Returns boolean

useUint16IndexArray

Returns boolean

Methods

addVertexBuffer

Parameters

parameters: VertexBufferParams = {}

Returns VertexBuffer

getVertexBufferByName

Parameters

name: string = ''

Returns VertexBuffer

setAttribute

Parameters

parameters: VertexBufferAttributeParams

Returns void

getAttributeByName

Parameters

name: string

Returns VertexBufferAttribute

computeGeometry

Returns void

setWGSLFragment

Returns void

uploadBuffer

Parameters

renderer: Renderer

buffer: GeometryBuffer

Returns void

useIndirectBuffer

Parameters

parameters: IndirectDrawParams

Returns void

render

Parameters

pass: GPURenderPassTypes

Returns void

loseContext

Returns void

restoreContext

Parameters

renderer: Renderer

Returns void

setIndexBuffer

Parameters

parameters: IndexedGeometryIndexBufferOptions

Returns void

createBuffers

Parameters

parameters: {
renderer: Renderer;
label?: string;
}

`Optional` label?: string