Class OpenPbrMaterial

Hierarchy (View Summary)

Material
- OpenPbrMaterial

Constructors

constructor

new OpenPbrMaterial(options?: OpenPbrMaterialOptions): OpenPbrMaterial
Parameters
- options: OpenPbrMaterialOptions = {}
Returns OpenPbrMaterial
Overrides Material.constructor
- Defined in src/renderer/materials/openpbr_material.ts:197

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: string = 'openpbr'

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.

baseWeight

baseWeight: number

baseColor

baseColor: [number, number, number]

baseMetalness

baseMetalness: number

baseDiffuseRoughness

baseDiffuseRoughness: number

specularWeight

specularWeight: number

specularColor

specularColor: [number, number, number]

specularRoughness

specularRoughness: number

specularIor

specularIor: number

specularAnisotropy

specularAnisotropy: number

specularRotation

specularRotation: number

coatWeight

coatWeight: number

coatColor

coatColor: [number, number, number]

coatRoughness

coatRoughness: number

coatIor

coatIor: number

coatDarkening

coatDarkening: number

fuzzWeight

fuzzWeight: number

fuzzColor

fuzzColor: [number, number, number]

fuzzRoughness

fuzzRoughness: number

subsurfaceWeight

subsurfaceWeight: number

subsurfaceColor

subsurfaceColor: [number, number, number]

thinFilmWeight

thinFilmWeight: number

thinFilmThickness

thinFilmThickness: number

thinFilmIor

thinFilmIor: number

emissionLuminance

emissionLuminance: number

emissionColor

emissionColor: [number, number, number]

transmissionWeight

transmissionWeight: number

Refractive transmission strength (glass). Default 0. Rendered by the forward TransmissionPass; not part of the forward/geometry uniform.

thickness

thickness: number

Volume thickness (Beer-Lambert). Default 0.

attenuationColor

attenuationColor: [number, number, number]

Beer-Lambert absorption color. Default [1,1,1].

attenuationDistance

attenuationDistance: number

Absorption distance. Default Infinity.

dispersion

dispersion: number

Chromatic dispersion. Default 0.

opacity

opacity: number

normalScale

normalScale: number

unlit

unlit: boolean

`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

baseColorMap

get baseColorMap(): Texture | undefined
Returns Texture | undefined
- Defined in src/renderer/materials/openpbr_material.ts:243
set baseColorMap(tex: Texture | undefined): void
Parameters
- tex: Texture | undefined
Returns void
- Defined in src/renderer/materials/openpbr_material.ts:244

normalMap

get normalMap(): Texture | undefined
Returns Texture | undefined
- Defined in src/renderer/materials/openpbr_material.ts:251
set normalMap(tex: Texture | undefined): void
Parameters
- tex: Texture | undefined
Returns void
- Defined in src/renderer/materials/openpbr_material.ts:252

metallicRoughnessMap

get metallicRoughnessMap(): Texture | undefined
Packed metallic / emissive-scalar / roughness map (engine MER convention: R=metallic ×, G=emissive scalar, B=roughness ×). Matches PbrMaterial.merMap, so a glTF metallic-roughness texture (swizzled to MER by the loader) transfers directly. 1×1 (metallic 1, roughness 1) default when absent.

Returns Texture | undefined
- Defined in src/renderer/materials/openpbr_material.ts:263
set metallicRoughnessMap(tex: Texture | undefined): void
Parameters
- tex: Texture | undefined
Returns void
- Defined in src/renderer/materials/openpbr_material.ts:264

emissiveMap

get emissiveMap(): Texture | undefined
sRGB emission texture; multiplied by emissionColor·emissionLuminance. 1×1 white default when absent (factor-only emission still works).

Returns Texture | undefined
- Defined in src/renderer/materials/openpbr_material.ts:273
set emissiveMap(tex: Texture | undefined): void
Parameters
- tex: Texture | undefined
Returns void
- Defined in src/renderer/materials/openpbr_material.ts:274

coatNormalMap

get coatNormalMap(): Texture | undefined
Clear-coat tangent-space normal map (forward path). 1×1 flat (0,0,1) default when absent → the coat uses the geometric normal.

Returns Texture | undefined
- Defined in src/renderer/materials/openpbr_material.ts:283
set coatNormalMap(tex: Texture | undefined): void
Parameters
- tex: Texture | undefined
Returns void
- Defined in src/renderer/materials/openpbr_material.ts:284

anisotropyMap

get anisotropyMap(): Texture | undefined
Anisotropy direction/strength map (KHR_materials_anisotropy); 1×1 default (dir (1,0), strength 1) when absent. Sampled by every OpenPBR shading path.

Returns Texture | undefined
- Defined in src/renderer/materials/openpbr_material.ts:293
set anisotropyMap(tex: Texture | undefined): void
Parameters
- tex: Texture | undefined
Returns void
- Defined in src/renderer/materials/openpbr_material.ts:294

variantMask

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

Methods

markDirty

markDirty(): void
Returns void
- Defined in src/renderer/materials/openpbr_material.ts:305

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/openpbr_material.ts:307

getBindGroupLayout

getBindGroupLayout(
device: GPUDevice,
variantMaskOverride?: 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
- OptionalvariantMaskOverride: number
Returns GPUBindGroupLayout
Overrides Material.getBindGroupLayout
- Defined in src/renderer/materials/openpbr_material.ts:334

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/openpbr_material.ts:368

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/openpbr_material.ts:421

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/openpbr_material.ts:488

Class OpenPbrMaterial

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OpenPbrMaterial

Properties

transparent

cullMode

ReadonlyshaderId

baseWeight

baseColor

baseMetalness

baseDiffuseRoughness

specularWeight

specularColor

specularRoughness

specularIor

specularAnisotropy

specularRotation

coatWeight

coatColor

coatRoughness

coatIor

coatDarkening

fuzzWeight

fuzzColor

fuzzRoughness

subsurfaceWeight

subsurfaceColor

thinFilmWeight

thinFilmThickness

thinFilmIor

emissionLuminance

emissionColor

transmissionWeight

thickness

attenuationColor

attenuationDistance

dispersion

opacity

normalScale

unlit

OptionaltransmissionMap

OptionalthicknessMap

Accessors

baseColorMap

Returns Texture | undefined

Parameters

Returns void

normalMap

Returns Texture | undefined

Parameters

Returns void

metallicRoughnessMap

Returns Texture | undefined

Parameters

Returns void

emissiveMap

Returns Texture | undefined

Parameters

Returns void

coatNormalMap

Returns Texture | undefined

Parameters

Returns void

anisotropyMap

Returns Texture | undefined

Parameters

Returns void

variantMask

Returns number

Methods

markDirty

Returns void

`Readonly`shaderId

`Optional`transmissionMap

`Optional`thicknessMap