Class ColorDataTextureArray

Instance color data as sampler2DArray (RGBA8, 1 texel per instance per layer).

Hierarchy (View Summary)

SquareDataTextureArray<Uint8Array, ColorDataTextureLayerProxy>
- ColorDataTextureArray

Index

Constructors

Properties

maxUpdateCalls partialUpdate

Accessors

capacity channels data layerProxies layers layerViews pixelsPerInstance texture

Methods

destroy enqueueDataUpdate enqueueDataUpdateLayer enqueueUpdate enqueueUpdateLayer getLayer getLayerData resize resizeLayers update upload

Constructors

constructor

new ColorDataTextureArray(
device: GraphicsDevice,
params: IColorDataTextureArrayParams,
): ColorDataTextureArray
Parameters
- device: GraphicsDevice
- params: IColorDataTextureArrayParams
Returns ColorDataTextureArray
Overrides SquareDataTextureArray.constructor
- Defined in Extras/ColorDataTexture.ts:118

Properties

maxUpdateCalls

maxUpdateCalls: number = Infinity

Maximum number of update calls per frame.

partialUpdate

partialUpdate: boolean = true

If true, the texture will be updated only if the data has changed.

Accessors

capacity

get capacity(): number
Maximum number of instances that the texture can hold.

Returns number
Inherited from SquareDataTextureArray.capacity
- Defined in Extras/SquareDataTextureArray.ts:73

channels

get channels(): TChannelSize
Number of channels per pixel.

Returns TChannelSize
Inherited from SquareDataTextureArray.channels
- Defined in Extras/SquareDataTextureArray.ts:71

data

get data(): TArray
Returns TArray
Inherited from SquareDataTextureArray.data
- Defined in Extras/SquareDataTextureArray.ts:75

layerProxies

get layerProxies(): TLayerProxy[]
Returns TLayerProxy[]
Inherited from SquareDataTextureArray.layerProxies
- Defined in Extras/SquareDataTextureArray.ts:77

layers

get layers(): number
Returns number
Inherited from SquareDataTextureArray.layers
- Defined in Extras/SquareDataTextureArray.ts:72

layerViews

get layerViews(): TArray[]
Data for each layer.

Returns TArray[]
Inherited from SquareDataTextureArray.layerViews
- Defined in Extras/SquareDataTextureArray.ts:76

pixelsPerInstance

get pixelsPerInstance(): number
Number of pixels per instance.

Returns number
Inherited from SquareDataTextureArray.pixelsPerInstance
- Defined in Extras/SquareDataTextureArray.ts:70

texture

get texture(): Texture
Texture.

Returns Texture
Inherited from SquareDataTextureArray.texture
- Defined in Extras/SquareDataTextureArray.ts:74

Methods

destroy

destroy(): void
Returns void
Inherited from SquareDataTextureArray.destroy
- Defined in Extras/SquareDataTextureArray.ts:124

enqueueDataUpdate

enqueueDataUpdate(index: number, inData: Uint8Array, offset?: number): void
Parameters
- index: number
- inData: Uint8Array
- offset: number = 0
Returns void
Inherited from SquareDataTextureArray.enqueueDataUpdate
- Defined in Extras/SquareDataTextureArray.ts:385

enqueueDataUpdateLayer

enqueueDataUpdateLayer(
    layer: number,
    index: number,
    inData: Uint8Array,
    offset?: number,
): void
Parameters
- layer: number
  Layer index.
- index: number
  Index of the instance.
- inData: Uint8Array
  Data to update.
- offset: number = 0
  Offset in the data.
Returns void
Inherited from SquareDataTextureArray.enqueueDataUpdateLayer
- Defined in Extras/SquareDataTextureArray.ts:405

enqueueUpdate

enqueueUpdate(index: number): void
Parameters
- index: number
Returns void
Inherited from SquareDataTextureArray.enqueueUpdate
- Defined in Extras/SquareDataTextureArray.ts:381

enqueueUpdateLayer

enqueueUpdateLayer(layer: number, index: number): void
Update data for specific layer.
Parameters
- layer: number
  Layer index.
- index: number
  Index of the instance.
Returns void
Inherited from SquareDataTextureArray.enqueueUpdateLayer
- Defined in Extras/SquareDataTextureArray.ts:389

getLayer

getLayer(layer: number): ColorDataTextureLayerProxy
Parameters
- layer: number
Returns ColorDataTextureLayerProxy
Inherited from SquareDataTextureArray.getLayer
- Defined in Extras/SquareDataTextureArray.ts:135

getLayerData

getLayerData(layer: number): Uint8Array<ArrayBufferLike>
Parameters
- layer: number
Returns Uint8Array<ArrayBufferLike>
Inherited from SquareDataTextureArray.getLayerData
- Defined in Extras/SquareDataTextureArray.ts:128

resize

resize(count: number, layers?: number): void
Resize instance capacity. Optionally change layer count in the same call. Changing layers recreates the GPU texture (arrayLength is immutable).
Parameters
- count: number
- layers: number = ...
Returns void
Inherited from SquareDataTextureArray.resize
- Defined in Extras/SquareDataTextureArray.ts:369

resizeLayers

resizeLayers(layers: number): void
Resize texture-array depth (sampler2DArray layers). Recreates the GPU texture; existing layer proxies for kept indices are reused.
Parameters
- layers: number
Returns void
Inherited from SquareDataTextureArray.resizeLayers
- Defined in Extras/SquareDataTextureArray.ts:377

update

update(): void
Update the texture on the GPU.

Returns void
Inherited from SquareDataTextureArray.update
- Defined in Extras/SquareDataTextureArray.ts:599

upload

upload(): void
Upload the texture to the GPU.

Returns void
Inherited from SquareDataTextureArray.upload
- Defined in Extras/SquareDataTextureArray.ts:593