Class CustomMaterial

Hierarchy (View Summary)

Material
- CustomMaterial

Index

Constructors

Properties

_dirty _uniformDataCache bindGroup bindGroupKey blendMode cullMode depthTest depthWrite pipeline uniformBuffer

Accessors

Methods

createBindGroupLayout destroy getShaderCode getUniform getUniformBufferSize getUniformData getUniformDataCache markClean setUniform

Constructors

constructor

new CustomMaterial(descriptor: CustomMaterialDescriptor): CustomMaterial
Parameters
- descriptor: CustomMaterialDescriptor
Returns CustomMaterial
Overrides Material.constructor
- Defined in graphics/material.ts:430

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

`Readonly`depthTest

depthTest: boolean

`Readonly`depthWrite

depthWrite: boolean

pipeline

pipeline: GPURenderPipeline | null = null

uniformBuffer

uniformBuffer: GPUBuffer | null = null

Accessors

dirty

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

Methods

createBindGroupLayout

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

destroy

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

getShaderCode

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

getUniform

getUniform(name: string): number | number[] | undefined
Parameters
- name: string
Returns number | number[] | undefined
- Defined in graphics/material.ts:444

getUniformBufferSize

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

getUniformData

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

`Protected`getUniformDataCache

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

markClean

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

setUniform

setUniform(name: string, value: number | number[]): void
Parameters
- name: string
- value: number | number[]
Returns void
- Defined in graphics/material.ts:437