Class GPUMemoryBatchInternal

constructor

• new GPUMemoryBatch(index: number, renderContext: RenderContext): GPUMemoryBatch

  Creates a new GPUMemoryBatch.

  Parameters

  • index: number
  • renderContext: RenderContext

  Returns GPUMemoryBatch

dataTextures

index

StaticitemSizesInBytes

• get itemSizesInBytes(): { [key: string]: number }

  Returns { [key: string]: number }

_getFreeGeometryIndex

• _getFreeGeometryIndex(): number

  Returns number

_getFreeMeshIndex

• _getFreeMeshIndex(): number

  Returns number

_putFreeGeometryIndex

• _putFreeGeometryIndex(index: number): void

  Parameters

  • index: number

  Returns void

_putFreeMeshIndex

• _putFreeMeshIndex(index: number): void

  Parameters

  • index: number

  Returns void

addMesh

• addMesh(sceneMesh: SceneMesh): SDKResult<number>

  Adds a SceneMesh to this GPUMemoryBatch.

  Returns an index through which you can dynamically update attributes for the mesh.

  Parameters

  • sceneMesh: SceneMesh

  Returns SDKResult<number>

allocate

• allocate(): SDKResult<void>

  Allocates all data textures for this GPUMemoryBatch.

  Returns SDKResult<void>

destroy

• destroy(): void

  Returns void

getAllocatedBytes

• getAllocatedBytes(): number

  Returns number

getDrawArraysParamsForMesh

• getDrawArraysParamsForMesh(meshIndex: number): { count: number; first: number }

  Retrieves parameters for a drawArrays() call to render a specific mesh.

  Parameters

  • meshIndex: number

  Returns { count: number; first: number }

getGeometryAtIndex

• getGeometryAtIndex(geometryIndex: number): SceneGeometry

  Retrieves a SceneGeometry by its geometryIndex.

  Parameters

  • geometryIndex: number

  Returns SceneGeometry

getMeshAtIndex

• getMeshAtIndex(meshIndex: number): SceneMesh

  Retrieves a SceneMesh by its meshIndex.

  Parameters

  • meshIndex: number

  Returns SceneMesh

getUsedBytes

• getUsedBytes(): number

  Returns the total number of bytes currently used by all managed arrays in this batch.

  Returns number

hasMemoryForMesh

• hasMemoryForMesh(sceneMesh: SceneMesh): boolean

  Check if there is enough memory for a SceneMesh.

  Parameters

  • sceneMesh: SceneMesh

  Returns boolean

removeMesh

• removeMesh(meshIndex: number): void

  Removes a SceneMesh from data texture manager.

  Parameters

  • meshIndex: number

  Returns void

setMeshAttribs

• setMeshAttribs(meshIndex: number, params: { tileIndex?: number }): void

  Sets attributes for e mesh to apply across all Views.

  Sets RenderContext.viewFlags[...].needsRender to true.

  Parameters

  • meshIndex: number
  • params: { tileIndex?: number }

    • OptionaltileIndex?: number

      Optional tileIndex of the GPUTile containing the mesh. This can be dynamically updated, as mesh can move between tiles.

  Returns void

setMeshMatrix

• setMeshMatrix(meshIndex: number, matrix: Mat4): void

  Sets the modeling transform matrix for a mesh. The modeling transform is relative to the center of the meshes tile.

  Sets RenderContext.viewFlags[...].needsRender to true.

  Parameters

  • meshIndex: number
  • matrix: Mat4

  Returns void

setMeshObjectVisible

• setMeshObjectVisible(
      meshIndex: number,
      viewIndex: number,
      visible: boolean,
  ): void

  TODO

  Parameters

  • meshIndex: number
  • viewIndex: number
  • visible: boolean

  Returns void

setMeshRenderPass

• setMeshRenderPass(
      meshIndex: number,
      viewIndex: number,
      renderPass: number,
  ): void

  Sets the renderPass for a SceneMesh within a specific View.

  Parameters

  • meshIndex: number
  • viewIndex: number
  • renderPass: number

  Returns void

setMeshViewAttribs

• setMeshViewAttribs(
      meshIndex: number,
      viewIndex: number,
      params: {
          clippable?: boolean;
          color?: Vec3;
          opacity?: number;
          pickable?: boolean;
      },
  ): void

  Sets attributes for a mesh within a specific View.

  Sets RenderContext.viewFlags[viewIndex].needsRender to true.

  Parameters

  • meshIndex: number
  • viewIndex: number
  • params: { clippable?: boolean; color?: Vec3; opacity?: number; pickable?: boolean }

  Returns void

setMeshVisible

• setMeshVisible(meshIndex: number, viewIndex: number, visible: boolean): void

  TODO

  Parameters

  • meshIndex: number
  • viewIndex: number
  • visible: boolean

  Returns void

uploadChanges

• uploadChanges(): boolean

  Flush any pending updates to the GPU.

  Returns boolean

webglContextRestored

• webglContextRestored(): SDKResult<void>

  Returns SDKResult<void>