Skip to main content

Type Alias: ProvisionTextureSetOptions<TextureType>

ProvisionTextureSetOptions<TextureType>: object

What a caller states to provision one named set.

Type Parameters​

• TextureType

Type declaration​

applyGrid()?​

optional applyGrid: (texture, grid) => void

States the grid on a texture. A slab calls this again on each re-point.

Parameters​

• texture: TextureType

• grid: VoxelGrid

Returns​

void

backstop?​

optional backstop: boolean

True for the set that a selection falls back on.

coverage?​

optional coverage: VolumeTextureSetDescription["coverage"]

Whether the members cover the whole volume between them.

createTexture()​

createTexture: (request) => TextureType

Builds one texture. The store calls this after it accepts the cost.

Parameters​

• request

• request.grid: VoxelGrid

• request.id: string

• request.setName: string

• request.statistic: VoxelStatistic

Returns​

TextureType

dataType?​

optional dataType: PixelDataTypedArrayString

The type of the voxel data, which gives the cost of one voxel.

destroyTexture()?​

optional destroyTexture: (texture) => void

Releases one texture. The store calls this when it evicts the set.

Parameters​

• texture: TextureType

Returns​

void

grids​

grids: VoxelGrid[]

The grids of the members. One grid gives a full-extent set.

limits?​

optional limits: VolumeTextureLimits

The limits of one texture. No limit by default.

markTextureSlice()?​

optional markTextureSlice: (slot, slice) => void

Marks one z slice of one texture for a refill.

A new texture holds uninitialised memory, so the store marks every slice of it. A slice that nothing marks is never uploaded, and it draws whatever the driver left in that memory.

Parameters​

• slot: VolumeTextureSlot<TextureType>

• slice: number

Returns​

void

name​

name: string

The name of the set, which a selection states to find the set again.

numberOfComponents?​

optional numberOfComponents: number

The number of components of one voxel. One by default.

ownerId?​

optional ownerId: string

The owner of a set of slabs that re-point. When a caller states an owner, every member is a slab with a front texture and a back texture, and only that owner may re-point or publish it. A set with no owner holds fixed textures that any number of viewports read.

statistic?​

optional statistic: VoxelStatistic

The statistic that every member holds.

volumeGrid​

volumeGrid: VoxelGrid

The grid of the volume, which is the index space of every region.

volumeId​

volumeId: string

The volume that owns the set.

Defined in​

packages/core/src/cache/volumeTextureStore.ts:34