Class ShaderMaterial

ShaderMaterial represents a fully customizable, user-driven shading material. Enables integration of bespoke WGSL vertex and fragment shader scripts, providing dynamic group 3 uniform buffers to drive animations and parameters. Automatically maps dummy group 2 resources to fulfill baseline pipeline signatures.

Hierarchy (View Summary)

Material
- ShaderMaterial

Accessors

albedoColor

get albedoColor(): Color
Gets the base albedo color.

Returns Color
Inherited from Material.albedoColor
- Defined in graphics/materials/material.ts:339
set albedoColor(val: ColorLike): void
Sets the base albedo color, setting dirty status upon color component modifications.
Parameters
- val: ColorLike
Returns void
Inherited from Material.albedoColor
- Defined in graphics/materials/material.ts:344

albedoTexture

get albedoTexture(): Texture | null
Gets the base albedo texture.

Returns Texture | null
Inherited from Material.albedoTexture
- Defined in graphics/materials/material.ts:359
set albedoTexture(val: string | Texture | null): void
Sets the base albedo texture, marking parameters and bind groups as dirty.
Parameters
- val: string | Texture | null
Returns void
Inherited from Material.albedoTexture
- Defined in graphics/materials/material.ts:364

aoIntensity

get aoIntensity(): number
Gets the ambient occlusion shadow intensity multiplier.

Returns number
Inherited from Material.aoIntensity
- Defined in graphics/materials/material.ts:462
set aoIntensity(val: number): void
Sets the ambient occlusion shadow intensity multiplier and marks the material parameters as dirty.
Parameters
- val: number
Returns void
Inherited from Material.aoIntensity
- Defined in graphics/materials/material.ts:467

aoTexture

get aoTexture(): Texture | null
Gets the ambient occlusion texture.

Returns Texture | null
Inherited from Material.aoTexture
- Defined in graphics/materials/material.ts:475
set aoTexture(val: string | Texture | null): void
Sets the ambient occlusion texture, marking parameters and bind groups as dirty.
Parameters
- val: string | Texture | null
Returns void
Inherited from Material.aoTexture
- Defined in graphics/materials/material.ts:480

cullMode

get cullMode(): CullMode | undefined
Gets the culling mode settings.

Returns CullMode | undefined
Inherited from Material.cullMode
- Defined in graphics/materials/material.ts:324
set cullMode(value: CullMode | undefined): void
Sets the culling mode settings.
Parameters
- value: CullMode | undefined
Returns void
Inherited from Material.cullMode
- Defined in graphics/materials/material.ts:329

depthCompare

get depthCompare(): GPUCompareFunction
Gets the depth check comparison function.

Returns GPUCompareFunction
Inherited from Material.depthCompare
- Defined in graphics/materials/material.ts:270
set depthCompare(value: GPUCompareFunction): void
Sets the depth check comparison function.
Parameters
- value: GPUCompareFunction
Returns void
Inherited from Material.depthCompare
- Defined in graphics/materials/material.ts:275

depthWriteEnabled

get depthWriteEnabled(): boolean
Gets whether depth buffer updates are enabled.

Returns boolean
Inherited from Material.depthWriteEnabled
- Defined in graphics/materials/material.ts:257
set depthWriteEnabled(value: boolean): void
Sets whether depth buffer updates are enabled.
Parameters
- value: boolean
Returns void
Inherited from Material.depthWriteEnabled
- Defined in graphics/materials/material.ts:262

doubleSided

get doubleSided(): boolean
Gets the double-sided rendering state.

Returns boolean
Inherited from Material.doubleSided
- Defined in graphics/materials/material.ts:556
set doubleSided(val: boolean): void
Sets the double-sided rendering state, adjusting internal cull modes accordingly.
Parameters
- val: boolean
Returns void
Inherited from Material.doubleSided
- Defined in graphics/materials/material.ts:561

emissiveColor

get emissiveColor(): Color
Gets the solid emissive color coefficients.

Returns Color
Inherited from Material.emissiveColor
- Defined in graphics/materials/material.ts:507
set emissiveColor(val: ColorLike): void
Sets the solid emissive color coefficients, setting dirty status upon color component modifications.
Parameters
- val: ColorLike
Returns void
Inherited from Material.emissiveColor
- Defined in graphics/materials/material.ts:512

emissiveStrength

get emissiveStrength(): number
Gets the emissive intensity multiplier.

Returns number
Inherited from Material.emissiveStrength
- Defined in graphics/materials/material.ts:543
set emissiveStrength(val: number): void
Sets the emissive intensity multiplier and marks the material parameters as dirty.
Parameters
- val: number
Returns void
Inherited from Material.emissiveStrength
- Defined in graphics/materials/material.ts:548

emissiveTexture

get emissiveTexture(): Texture | null
Gets the emissive texture.

Returns Texture | null
Inherited from Material.emissiveTexture
- Defined in graphics/materials/material.ts:527
set emissiveTexture(val: string | Texture | null): void
Sets the emissive texture, marking parameters and bind groups as dirty.
Parameters
- val: string | Texture | null
Returns void
Inherited from Material.emissiveTexture
- Defined in graphics/materials/material.ts:532

metallic

get metallic(): number
Gets the microfacet metallic factor.

Returns number
Inherited from Material.metallic
- Defined in graphics/materials/material.ts:433
set metallic(val: number): void
Sets the microfacet metallic factor and marks the material parameters as dirty.
Parameters
- val: number
Returns void
Inherited from Material.metallic
- Defined in graphics/materials/material.ts:438

metallicTexture

get metallicTexture(): Texture | null
Gets the metallic texture.

Returns Texture | null
Inherited from Material.metallicTexture
- Defined in graphics/materials/material.ts:446
set metallicTexture(val: string | Texture | null): void
Sets the metallic texture, marking parameters and bind groups as dirty.
Parameters
- val: string | Texture | null
Returns void
Inherited from Material.metallicTexture
- Defined in graphics/materials/material.ts:451

normalScale

get normalScale(): number
Gets the normal tangent scale.

Returns number
Inherited from Material.normalScale
- Defined in graphics/materials/material.ts:375
set normalScale(val: number): void
Sets the normal tangent scale and marks the material parameters as dirty.
Parameters
- val: number
Returns void
Inherited from Material.normalScale
- Defined in graphics/materials/material.ts:380

normalTexture

get normalTexture(): Texture | null
Gets the normal texture.

Returns Texture | null
Inherited from Material.normalTexture
- Defined in graphics/materials/material.ts:388
set normalTexture(val: string | Texture | null): void
Sets the normal texture, marking parameters and bind groups as dirty.
Parameters
- val: string | Texture | null
Returns void
Inherited from Material.normalTexture
- Defined in graphics/materials/material.ts:393

opacity

get opacity(): number
Gets the opacity component of the albedo color.

Returns number
Inherited from Material.opacity
- Defined in graphics/materials/material.ts:301
set opacity(value: number): void
Sets the opacity component of the albedo color, automatically enabling transparent rendering and disabling depth writing if opacity is less than 1.0.
Parameters
- value: number
Returns void
Inherited from Material.opacity
- Defined in graphics/materials/material.ts:306

ormTexture

get ormTexture(): Texture | null
Gets the ORM texture.

Returns Texture | null
Inherited from Material.ormTexture
- Defined in graphics/materials/material.ts:491
set ormTexture(val: string | Texture | null): void
Sets the ORM texture, marking parameters and bind groups as dirty.
Parameters
- val: string | Texture | null
Returns void
Inherited from Material.ormTexture
- Defined in graphics/materials/material.ts:496

roughness

get roughness(): number
Gets the microfacet roughness factor.

Returns number
Inherited from Material.roughness
- Defined in graphics/materials/material.ts:404
set roughness(val: number): void
Sets the microfacet roughness factor and marks the material parameters as dirty.
Parameters
- val: number
Returns void
Inherited from Material.roughness
- Defined in graphics/materials/material.ts:409

roughnessTexture

get roughnessTexture(): Texture | null
Gets the roughness texture.

Returns Texture | null
Inherited from Material.roughnessTexture
- Defined in graphics/materials/material.ts:417
set roughnessTexture(val: string | Texture | null): void
Sets the roughness texture, marking parameters and bind groups as dirty.
Parameters
- val: string | Texture | null
Returns void
Inherited from Material.roughnessTexture
- Defined in graphics/materials/material.ts:422

shaderCode

get shaderCode(): string
Gets the WGSL custom shader code containing entry points.

Returns string
- Defined in graphics/materials/shader-material.ts:74
set shaderCode(val: string): void
Sets the WGSL custom shader code and marks the material as dirty.
Parameters
- val: string
Returns void
- Defined in graphics/materials/shader-material.ts:79

transparent

get transparent(): boolean
Gets whether transparency blending is enabled.

Returns boolean
Inherited from Material.transparent
- Defined in graphics/materials/material.ts:283
set transparent(value: boolean): void
Sets whether transparency blending is enabled. Automatically sets depthWriteEnabled to false if transparent is true.
Parameters
- value: boolean
Returns void
Inherited from Material.transparent
- Defined in graphics/materials/material.ts:288

Constructors

constructor

new ShaderMaterial(options: ShaderMaterialOptions): ShaderMaterial
Instantiates a new ShaderMaterial.
Parameters
- options: ShaderMaterialOptions
  Shader options containing script code and custom parameters.
Returns ShaderMaterial
Overrides Material.constructor
- Defined in graphics/materials/shader-material.ts:114

Methods

destroy

destroy(ctx: Context): void
Releases custom shader material resources (GPUBuffers) and unregisters entries from the VRAM tracker.
Parameters
- ctx: Context
  Active context.
Returns void
Overrides Material.destroy
- Defined in graphics/materials/shader-material.ts:433

getBindGroup

getBindGroup(
    ctx: Context,
    _topology?: GPUPrimitiveTopology,
    _indexFormat?: GPUIndexFormat,
): GPUBindGroup
Resolves GPUBindGroup (group index 2) containing baseline material bindings. Updates baseline uniform buffers and binds actual standard textures.
Parameters
- ctx: Context
  Active context.
- _topology: GPUPrimitiveTopology = "triangle-list"
- _indexFormat: GPUIndexFormat = "uint16"
Returns GPUBindGroup
Baseline material GPUBindGroup.
Overrides Material.getBindGroup
- Defined in graphics/materials/shader-material.ts:240

getParamsBindGroup

getParamsBindGroup(ctx: Context): GPUBindGroup | null
Resolves the custom GPUBindGroup (group index 3) containing active parameter values. Returns null if no custom parameters were initialized during construction.
Parameters
- ctx: Context
  Active context.
Returns GPUBindGroup | null
Custom parameter GPUBindGroup or null.
Overrides Material.getParamsBindGroup
- Defined in graphics/materials/shader-material.ts:380

getPipeline

getPipeline(
    ctx: Context,
    topology?: GPUPrimitiveTopology,
    indexFormat?: GPUIndexFormat,
    cullMode?: GPUCullMode,
    useCSM?: boolean,
): GPURenderPipeline
Compiles or returns the cached GPURenderPipeline corresponding to this custom shader configuration.
Parameters
- ctx: Context
  Active context.
- topology: GPUPrimitiveTopology = "triangle-list"
  Primitive geometry topology type.
- indexFormat: GPUIndexFormat = "uint16"
  Geometry index buffer type.
- OptionalcullMode: GPUCullMode
  Culling mode override.
- useCSM: boolean = false
Returns GPURenderPipeline
The compiled GPURenderPipeline.
Overrides Material.getPipeline
- Defined in graphics/materials/shader-material.ts:202

`Protected`onPropertyChange

onPropertyChange(): void
Invalidate cached bind group when properties change.

Returns void
Overrides Material.onPropertyChange
- Defined in graphics/materials/shader-material.ts:185

`Protected`resolvePendingTextures

resolvePendingTextures(ctx: Context): void
Asynchronously loads pending texture strings in the background and resolves them into Texture objects.
Parameters
- ctx: Context
Returns void
Inherited from Material.resolvePendingTextures
- Defined in graphics/materials/material.ts:571

setParameters

setParameters(params: ShaderParameters): void
Updates custom shader parameters at runtime. Writes data to GPU uniform buffers immediately, altering visual features on the next frame. Re-allocates storage buffers if the float size count changes.
Parameters
- params: ShaderParameters
  Map of updated parameter values.
Returns void
- Defined in graphics/materials/shader-material.ts:158

setUniforms

setUniforms(uniforms: ShaderParameters): void
Legacy alias for setParameters().
Parameters
- uniforms: ShaderParameters
  Map of updated parameter values.
Returns void
- Defined in graphics/materials/shader-material.ts:180

Properties

customBindGroup

customBindGroup: GPUBindGroup | null = null

Deprecated

Direct custom bind group override. Set customBindGroup directly for fully custom group(2) setups.

id

id: number

Unique material identification key.

isDirty

isDirty: boolean = true

Flag indicating if parameter properties are dirty, requiring a new bind group build.

nextPass

nextPass: Material | null = null

Secondary material rendered on top of the current pass. Assign a ShaderMaterial here to layer a second render pass (e.g., outline effect) over the primary material. The next pass automatically uses the same geometry and instance matrices, drawn immediately after.

type

type: string = "Material"

Material class type string tag used for fast runtime polymorphism checks.

Class ShaderMaterial

Hierarchy (View Summary)

Index

Accessors

Constructors

Methods

Properties

Accessors

albedoColor

Returns Color

Parameters

Returns void

albedoTexture

Returns Texture | null

Parameters

Returns void

aoIntensity

Returns number

Parameters

Returns void

aoTexture

Returns Texture | null

Parameters

Returns void

cullMode

Returns CullMode | undefined

Parameters

Returns void

depthCompare

Returns GPUCompareFunction

Parameters

Returns void

depthWriteEnabled

Returns boolean

Parameters

Returns void

doubleSided

Returns boolean

Parameters

Returns void

emissiveColor

Returns Color

Parameters

Returns void

emissiveStrength

Returns number

Parameters

Returns void

emissiveTexture

Returns Texture | null

Parameters

Returns void

metallic

Returns number

Parameters

Returns void

metallicTexture

Returns Texture | null

Parameters

Returns void

normalScale

Returns number

Parameters

Returns void

normalTexture

Returns Texture | null

Parameters

Returns void

opacity

Returns number

Parameters

Returns void

ormTexture

Returns Texture | null

Parameters

Returns void

roughness

Returns number

Parameters

Returns void

`Protected`onPropertyChange

`Protected`resolvePendingTextures