Class DataMaterial

Hierarchy (View Summary)

Material
- DataMaterial

Constructors

constructor

new DataMaterial(desc?: DataMaterialDescriptor): DataMaterial
Parameters
- desc: DataMaterialDescriptor = {}
Returns DataMaterial
Overrides Material.constructor
- Defined in graphics/material.ts:480

Properties

`Protected`_dirty

_dirty: boolean = true

`Protected`_uniformDataCache

_uniformDataCache: Float32Array<ArrayBufferLike> | null = null

bindGroup

bindGroup: GPUBindGroup | null = null

bindGroupKey

bindGroupKey: string | null = null

`Readonly`blendMode

blendMode: BlendMode

`Readonly`cullMode

cullMode: CullMode

dataBuffer

dataBuffer: GPUBuffer | null = null

`Readonly`depthTest

depthTest: boolean

`Readonly`depthWrite

depthWrite: boolean

pipeline

pipeline: GPURenderPipeline | null = null

uniformBuffer

uniformBuffer: GPUBuffer | null = null

Accessors

clipMax

get clipMax(): number
Returns number
- Defined in graphics/material.ts:609
set clipMax(v: number): void
Parameters
- v: number
Returns void
- Defined in graphics/material.ts:613

clipMin

get clipMin(): number
Returns number
- Defined in graphics/material.ts:599
set clipMin(v: number): void
Parameters
- v: number
Returns void
- Defined in graphics/material.ts:603

colormap

get colormap(): BuiltinColormapName | Colormap
Returns BuiltinColormapName | Colormap
- Defined in graphics/material.ts:715
set colormap(v: BuiltinColormapName | Colormap): void
Parameters
- v: BuiltinColormapName | Colormap
Returns void
- Defined in graphics/material.ts:719

componentCount

get componentCount(): number
Returns number
- Defined in graphics/material.ts:523
set componentCount(v: number): void
Parameters
- v: number
Returns void
- Defined in graphics/material.ts:527

componentIndex

get componentIndex(): number
Returns number
- Defined in graphics/material.ts:533
set componentIndex(v: number): void
Parameters
- v: number
Returns void
- Defined in graphics/material.ts:537

dirty

get dirty(): boolean
Returns boolean
Inherited from Material.dirty
- Defined in graphics/material.ts:56

domainMax

get domainMax(): number
Returns number
- Defined in graphics/material.ts:583
set domainMax(v: number): void
Parameters
- v: number
Returns void
- Defined in graphics/material.ts:587

domainMin

get domainMin(): number
Returns number
- Defined in graphics/material.ts:573
set domainMin(v: number): void
Parameters
- v: number
Returns void
- Defined in graphics/material.ts:577

gamma

get gamma(): number
Returns number
- Defined in graphics/material.ts:685
set gamma(v: number): void
Parameters
- v: number
Returns void
- Defined in graphics/material.ts:689

invert

get invert(): boolean
Returns boolean
- Defined in graphics/material.ts:675
set invert(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in graphics/material.ts:679

logBase

get logBase(): number
Returns number
- Defined in graphics/material.ts:645
set logBase(v: number): void
Parameters
- v: number
Returns void
- Defined in graphics/material.ts:649

offset

get offset(): number
Returns number
- Defined in graphics/material.ts:563
set offset(v: number): void
Parameters
- v: number
Returns void
- Defined in graphics/material.ts:567

opacity

get opacity(): number
Returns number
- Defined in graphics/material.ts:695
set opacity(v: number): void
Parameters
- v: number
Returns void
- Defined in graphics/material.ts:699

scaleMode

get scaleMode(): DataScaleMode
Returns DataScaleMode
- Defined in graphics/material.ts:625
set scaleMode(v: DataScaleMode): void
Parameters
- v: DataScaleMode
Returns void
- Defined in graphics/material.ts:629

shading

get shading(): number
Returns number
- Defined in graphics/material.ts:705
set shading(v: number): void
Parameters
- v: number
Returns void
- Defined in graphics/material.ts:709

stride

get stride(): number
Returns number
- Defined in graphics/material.ts:553
set stride(v: number): void
Parameters
- v: number
Returns void
- Defined in graphics/material.ts:557

symlogLinThresh

get symlogLinThresh(): number
Returns number
- Defined in graphics/material.ts:635
set symlogLinThresh(v: number): void
Parameters
- v: number
Returns void
- Defined in graphics/material.ts:639

tMax

get tMax(): number
Returns number
- Defined in graphics/material.ts:665
set tMax(v: number): void
Parameters
- v: number
Returns void
- Defined in graphics/material.ts:669

tMin

get tMin(): number
Returns number
- Defined in graphics/material.ts:655
set tMin(v: number): void
Parameters
- v: number
Returns void
- Defined in graphics/material.ts:659

valueMode

get valueMode(): DataValueMode
Returns DataValueMode
- Defined in graphics/material.ts:543
set valueMode(v: DataValueMode): void
Parameters
- v: DataValueMode
Returns void
- Defined in graphics/material.ts:547

Methods

computeClipFromCPUData

computeClipFromCPUData(lowPercentile: number, highPercentile: number): void
Parameters
- lowPercentile: number
- highPercentile: number
Returns void
- Defined in graphics/material.ts:800

computeDomainFromCPUData

computeDomainFromCPUData(): void
Returns void
- Defined in graphics/material.ts:767

createBindGroupLayout

createBindGroupLayout(device: GPUDevice): GPUBindGroupLayout
Parameters
- device: GPUDevice
Returns GPUBindGroupLayout
Overrides Material.createBindGroupLayout
- Defined in graphics/material.ts:898

destroy

destroy(): void
Returns void
Overrides Material.destroy
- Defined in graphics/material.ts:917

dropCPUData

dropCPUData(): void
Returns void
- Defined in graphics/material.ts:763

getColormapForBinding

getColormapForBinding(): Colormap
Returns Colormap
- Defined in graphics/material.ts:729

getColormapKey

getColormapKey(): string
Returns string
- Defined in graphics/material.ts:724

getShaderCode

getShaderCode(
_opts?: { instanced?: boolean; skinned?: boolean; skinned8?: boolean },
): string
Parameters
- _opts: { instanced?: boolean; skinned?: boolean; skinned8?: boolean } = {}
Returns string
Overrides Material.getShaderCode
- Defined in graphics/material.ts:913

getUniformBufferSize

getUniformBufferSize(): number
Returns number
Overrides Material.getUniformBufferSize
- Defined in graphics/material.ts:869

getUniformData

getUniformData(): Float32Array
Returns Float32Array
Overrides Material.getUniformData
- Defined in graphics/material.ts:873

`Protected`getUniformDataCache

getUniformDataCache(floatCount: number): Float32Array
Parameters
- floatCount: number
Returns Float32Array
Inherited from Material.getUniformDataCache
- Defined in graphics/material.ts:64

markClean

markClean(): void
Returns void
Inherited from Material.markClean
- Defined in graphics/material.ts:60

setClip

setClip(min: number, max: number): void
Parameters
- min: number
- max: number
Returns void
- Defined in graphics/material.ts:619

setData

setData(
    data: Float32Array,
    opts?: {
        componentCount?: number;
        keepCPUData?: boolean;
        offset?: number;
        stride?: number;
    },
): void
Parameters
- data: Float32Array
- opts: {
      componentCount?: number;
      keepCPUData?: boolean;
      offset?: number;
      stride?: number;
  } = {}
Returns void
- Defined in graphics/material.ts:735

setDataBuffer

setDataBuffer(
buffer: GPUBuffer,
opts?: { componentCount?: number; offset?: number; stride?: number },
): void
Parameters
- buffer: GPUBuffer
- opts: { componentCount?: number; offset?: number; stride?: number } = {}
Returns void
- Defined in graphics/material.ts:749

setDomain

setDomain(min: number, max: number): void
Parameters
- min: number
- max: number
Returns void
- Defined in graphics/material.ts:593

upload

upload(device: GPUDevice, queue: GPUQueue): void
Parameters
- device: GPUDevice
- queue: GPUQueue
Returns void
- Defined in graphics/material.ts:841