Class PbrMaterial

Hierarchy (View Summary)

Material
- PbrMaterial

Constructors

constructor

new PbrMaterial(options?: PbrMaterialOptions): PbrMaterial
Parameters
- options: PbrMaterialOptions = {}
Returns PbrMaterial
Overrides Material.constructor
- Defined in src/renderer/materials/pbr_material.ts:475

Properties

transparent

transparent: boolean = false

True for alpha-blended materials. ForwardPass routes these through its transparent sub-pass (after opaque) with depth-write disabled.

cullMode

cullMode: GPUCullMode = 'back'

Face-culling mode used when a pass builds this material's render pipeline: 'back' (default) culls back faces, 'front' culls front faces, 'none' draws both sides. A per-draw doubleSided flag (e.g. mixed-winding tile content) forces 'none' regardless of this setting. Passes fold this into their pipeline cache key, so it may differ between instances sharing a shaderId.

`Readonly`shaderId

shaderId: "pbr" = 'pbr'

Stable per-subclass identifier. All instances with the same shaderId MUST produce identical getShaderCode output and identical getBindGroupLayout layouts on a given device — the pass uses this as the pipeline cache key.

albedo

albedo: [number, number, number, number]

roughness

roughness: number

metallic

metallic: number

specular

specular: number

Dielectric specular reflectance scalar (F0 = 0.08·specular). Default 0.5.

specularColor

specularColor: [number, number, number]

Dielectric specular color tint (F0 rgb). Default [1,1,1].

clearcoat

clearcoat: number

Clear-coat strength (KHR_materials_clearcoat). Default 0 (no coat).

clearcoatRoughness

clearcoatRoughness: number

Clear-coat roughness. Default 0.

clearcoatNormalToGeometric

clearcoatNormalToGeometric: boolean

Coat uses the smooth geometric normal instead of the base normal. Default false.

clothWrap

clothWrap: number

Cloth diffuse-wrap strength [0,1] (Filament cloth). Default 0.

sheenColor

sheenColor: [number, number, number]

Sheen color (KHR_materials_sheen). Default [0,0,0] (no sheen).

sheenRoughness

sheenRoughness: number

Sheen roughness. Default 0.

iridescence

iridescence: number

Thin-film iridescence strength (KHR_materials_iridescence). Default 0.

iridescenceIor

iridescenceIor: number

Thin-film IOR. Default 1.3.

iridescenceThickness

iridescenceThickness: number

Thin-film thickness in nm. Default 400.

diffuseTransmission

diffuseTransmission: number

Diffuse transmission strength (KHR_materials_diffuse_transmission). Default 0.

diffuseTransmissionColor

diffuseTransmissionColor: [number, number, number]

Transmitted diffuse tint. Default [1,1,1].

subsurface

subsurface: number

Subsurface scattering strength (engine shading model). Default 0 (off).

subsurfaceColor

subsurfaceColor: [number, number, number]

Subsurface scattered-light tint. Default [1,1,1].

transmission

transmission: number

Refractive transmission strength (KHR_materials_transmission). Default 0.

ior

ior: number

Index of refraction (KHR_materials_ior). Default 1.5.

thickness

thickness: number

Volume thickness in world units (KHR_materials_volume). Default 0 (thin).

attenuationColor

attenuationColor: [number, number, number]

Beer-Lambert absorption color. Default [1,1,1] (none).

attenuationDistance

attenuationDistance: number

Absorption distance. Default Infinity (none).

dispersion

dispersion: number

Chromatic dispersion strength (KHR_materials_dispersion). Default 0.

emissiveFactor

emissiveFactor: [number, number, number]

`Optional`uvOffset

uvOffset?: [number, number]

`Optional`uvScale

uvScale?: [number, number]

`Optional`uvTile

uvTile?: [number, number]

uvRotation

uvRotation: number

UV rotation in radians (glTF KHR_texture_transform). Default 0.

alphaCutoff

alphaCutoff: number

MASK alpha-test threshold; 0 disables (glTF alphaCutoff). Default 0.

pixelated

pixelated: boolean

Nearest (point) texture filtering instead of linear. Default false.

normalScale

normalScale: number

Tangent-space normal XY multiplier (glTF normalTexture.scale). Default 1.

unlit

unlit: boolean

Unlit shading (KHR_materials_unlit) — skips lighting/IBL. Default false.

anisotropyStrength

anisotropyStrength: number

Anisotropy strength (KHR_materials_anisotropy). Default 0 (isotropic).

anisotropyRotation

anisotropyRotation: number

Anisotropy direction angle in radians. Default 0.

texCoordMask

texCoordMask: number

Per-texture UV-set selector bitmask (glTF texCoord); see PbrMaterialOptions.texCoordMask. Default 0.

`Optional`transmissionMap

transmissionMap?: Texture

Per-pixel transmission/thickness maps — read by the TransmissionPass, not part of this material's group-2 bind group.

`Optional`thicknessMap

thicknessMap?: Texture

Accessors

albedoMap

get albedoMap(): Texture | undefined
Returns Texture | undefined
- Defined in src/renderer/materials/pbr_material.ts:525
set albedoMap(tex: Texture | undefined): void
Parameters
- tex: Texture | undefined
Returns void
- Defined in src/renderer/materials/pbr_material.ts:526

normalMap

get normalMap(): Texture | undefined
Returns Texture | undefined
- Defined in src/renderer/materials/pbr_material.ts:533
set normalMap(tex: Texture | undefined): void
Parameters
- tex: Texture | undefined
Returns void
- Defined in src/renderer/materials/pbr_material.ts:534

merMap

get merMap(): Texture | undefined
Returns Texture | undefined
- Defined in src/renderer/materials/pbr_material.ts:541
set merMap(tex: Texture | undefined): void
Parameters
- tex: Texture | undefined
Returns void
- Defined in src/renderer/materials/pbr_material.ts:542

emissiveMap

get emissiveMap(): Texture | undefined
Returns Texture | undefined
- Defined in src/renderer/materials/pbr_material.ts:549
set emissiveMap(tex: Texture | undefined): void
Parameters
- tex: Texture | undefined
Returns void
- Defined in src/renderer/materials/pbr_material.ts:550

extMap

get extMap(): Texture | undefined
Returns Texture | undefined
- Defined in src/renderer/materials/pbr_material.ts:557
set extMap(tex: Texture | undefined): void
Parameters
- tex: Texture | undefined
Returns void
- Defined in src/renderer/materials/pbr_material.ts:558

anisotropyMap

get anisotropyMap(): Texture | undefined
Returns Texture | undefined
- Defined in src/renderer/materials/pbr_material.ts:565
set anisotropyMap(tex: Texture | undefined): void
Parameters
- tex: Texture | undefined
Returns void
- Defined in src/renderer/materials/pbr_material.ts:566

variantMask

get variantMask(): number
Returns number
- Defined in src/renderer/materials/pbr_material.ts:573

Methods

markDirty

markDirty(): void
Returns void
- Defined in src/renderer/materials/pbr_material.ts:610

getShaderCode

getShaderCode(passType: MaterialPassType, _variantMask?: number): string
Returns the WGSL source for a given pass type and variant mask.
Parameters
- passType: MaterialPassType
  Which pass is asking.
- Optional_variantMask: number
Returns string
WGSL source.

Throws
If the material does not support passType.
Overrides Material.getShaderCode
- Defined in src/renderer/materials/pbr_material.ts:612

getBindGroupLayout

getBindGroupLayout(
device: GPUDevice,
variantMaskOverrides?: number,
): GPUBindGroupLayout
Returns the bind group layout for slot MATERIAL_GROUP. Implementations MUST cache the layout per device — typically with a static WeakMap<GPUDevice, ...>.
Parameters
- device: GPUDevice
- OptionalvariantMaskOverrides: number
Returns GPUBindGroupLayout
Overrides Material.getBindGroupLayout
- Defined in src/renderer/materials/pbr_material.ts:623

getBindGroup

getBindGroup(device: GPUDevice): GPUBindGroup
Returns the bind group instance for slot MATERIAL_GROUP. Implementations may cache the bind group internally and recreate it lazily when textures or other resource references change.
Parameters
- device: GPUDevice
Returns GPUBindGroup
Overrides Material.getBindGroup
- Defined in src/renderer/materials/pbr_material.ts:662

update

update(queue: GPUQueue): void
Optional: called by the pass once per draw before binding, so the material can flush any dirty CPU-side parameter changes into its uniform buffers.
Parameters
- queue: GPUQueue
Returns void
Overrides Material.update
- Defined in src/renderer/materials/pbr_material.ts:742

destroy

destroy(): void
Optional: release any GPU resources owned by this material instance (uniform buffers, owned textures). Bind group layouts shared across instances should NOT be destroyed here.

Returns void
Overrides Material.destroy
- Defined in src/renderer/materials/pbr_material.ts:801

Class PbrMaterial

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PbrMaterial

Properties

transparent

cullMode

ReadonlyshaderId

albedo

roughness

metallic

specular

specularColor

clearcoat

clearcoatRoughness

clearcoatNormalToGeometric

clothWrap

sheenColor

sheenRoughness

iridescence

iridescenceIor

iridescenceThickness

diffuseTransmission

diffuseTransmissionColor

subsurface

subsurfaceColor

transmission

ior

thickness

attenuationColor

attenuationDistance

dispersion

emissiveFactor

OptionaluvOffset

OptionaluvScale

OptionaluvTile

uvRotation

alphaCutoff

pixelated

normalScale

unlit

anisotropyStrength

anisotropyRotation

texCoordMask

OptionaltransmissionMap

OptionalthicknessMap

Accessors

albedoMap

Returns Texture | undefined

Parameters

Returns void

normalMap

Returns Texture | undefined

Parameters

Returns void

merMap

Returns Texture | undefined

Parameters

Returns void

emissiveMap

Returns Texture | undefined

Parameters

Returns void

extMap

Returns Texture | undefined

Parameters

Returns void

anisotropyMap

Returns Texture | undefined

Parameters

Returns void

variantMask

Returns number

`Readonly`shaderId

`Optional`uvOffset

`Optional`uvScale

`Optional`uvTile

`Optional`transmissionMap

`Optional`thicknessMap