Class MaterialAbstract

albedoColor

• get albedoColor(): Color

  Gets the base albedo color.

  Returns Color

• set albedoColor(val: ColorLike): void

  Sets the base albedo color, setting dirty status upon color component modifications.

  Parameters

  • val: ColorLike

  Returns void

albedoTexture

• get albedoTexture(): Texture | null

  Gets the base albedo texture.

  Returns Texture | null

• 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

aoIntensity

• get aoIntensity(): number

  Gets the ambient occlusion shadow intensity multiplier.

  Returns number

• set aoIntensity(val: number): void

  Sets the ambient occlusion shadow intensity multiplier and marks the material parameters as dirty.

  Parameters

  • val: number

  Returns void

aoTexture

• get aoTexture(): Texture | null

  Gets the ambient occlusion texture.

  Returns Texture | null

• 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

cullMode

• get cullMode(): CullMode | undefined

  Gets the culling mode settings.

  Returns CullMode | undefined

• set cullMode(value: CullMode | undefined): void

  Sets the culling mode settings.

  Parameters

  • value: CullMode | undefined

  Returns void

depthCompare

• get depthCompare(): GPUCompareFunction

  Gets the depth check comparison function.

  Returns GPUCompareFunction

• set depthCompare(value: GPUCompareFunction): void

  Sets the depth check comparison function.

  Parameters

  • value: GPUCompareFunction

  Returns void

depthWriteEnabled

• get depthWriteEnabled(): boolean

  Gets whether depth buffer updates are enabled.

  Returns boolean

• set depthWriteEnabled(value: boolean): void

  Sets whether depth buffer updates are enabled.

  Parameters

  • value: boolean

  Returns void

doubleSided

• get doubleSided(): boolean

  Gets the double-sided rendering state.

  Returns boolean

• set doubleSided(val: boolean): void

  Sets the double-sided rendering state, adjusting internal cull modes accordingly.

  Parameters

  • val: boolean

  Returns void

emissiveColor

• get emissiveColor(): Color

  Gets the solid emissive color coefficients.

  Returns Color

• set emissiveColor(val: ColorLike): void

  Sets the solid emissive color coefficients, setting dirty status upon color component modifications.

  Parameters

  • val: ColorLike

  Returns void

emissiveStrength

• get emissiveStrength(): number

  Gets the emissive intensity multiplier.

  Returns number

• set emissiveStrength(val: number): void

  Sets the emissive intensity multiplier and marks the material parameters as dirty.

  Parameters

  • val: number

  Returns void

emissiveTexture

• get emissiveTexture(): Texture | null

  Gets the emissive texture.

  Returns Texture | null

• 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

metallic

• get metallic(): number

  Gets the microfacet metallic factor.

  Returns number

• set metallic(val: number): void

  Sets the microfacet metallic factor and marks the material parameters as dirty.

  Parameters

  • val: number

  Returns void

metallicTexture

• get metallicTexture(): Texture | null

  Gets the metallic texture.

  Returns Texture | null

• 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

normalScale

• get normalScale(): number

  Gets the normal tangent scale.

  Returns number

• set normalScale(val: number): void

  Sets the normal tangent scale and marks the material parameters as dirty.

  Parameters

  • val: number

  Returns void

normalTexture

• get normalTexture(): Texture | null

  Gets the normal texture.

  Returns Texture | null

• 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

opacity

• get opacity(): number

  Gets the opacity component of the albedo color.

  Returns number

• 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

ormTexture

• get ormTexture(): Texture | null

  Gets the ORM texture.

  Returns Texture | null

• 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

roughness

• get roughness(): number

  Gets the microfacet roughness factor.

  Returns number

• set roughness(val: number): void

  Sets the microfacet roughness factor and marks the material parameters as dirty.

  Parameters

  • val: number

  Returns void

roughnessTexture

• get roughnessTexture(): Texture | null

  Gets the roughness texture.

  Returns Texture | null

• 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

transparent

• get transparent(): boolean

  Gets whether transparency blending is enabled.

  Returns boolean

• 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

constructor

• new Material(options?: MaterialOptions): Material

  Instantiates a new Material.

  Parameters

  • options: MaterialOptions = {}

    Material base configuration options.

  Returns Material

Abstractdestroy

• destroy(ctx: Context): void

  Abstract method performing resource cleanup (releasing GPU buffers and removing allocations tracker entries).

  Parameters

  • ctx: Context

    Target framework context.

  Returns void

AbstractgetBindGroup

• getBindGroup(
      ctx: Context,
      topology?: GPUPrimitiveTopology,
      indexFormat?: GPUIndexFormat,
  ): GPUBindGroup

  Abstract method compiling or fetching the primary GPUBindGroup (group index 2) representing PBR parameters.

  Parameters

  • ctx: Context

    Active context.

  • Optionaltopology: GPUPrimitiveTopology

    Geometry topology.

  • OptionalindexFormat: GPUIndexFormat

    Geometry index format.

  Returns GPUBindGroup

  The resolved material GPUBindGroup.

getParamsBindGroup

• getParamsBindGroup(_ctx: Context): GPUBindGroup | null

  Custom parameter bind group (group index 3) utilized by custom ShaderMaterials. Returns null by default for StandardMaterial.

  Parameters

  • _ctx: Context

    Active context.

  Returns GPUBindGroup | null

  The resolved custom parameters bind group or null.

AbstractgetPipeline

• getPipeline(
      ctx: Context,
      topology?: GPUPrimitiveTopology,
      indexFormat?: GPUIndexFormat,
      cullMode?: GPUCullMode,
      useCSM?: boolean,
  ): GPURenderPipeline

  Abstract method compiling or retrieving the cached GPURenderPipeline matching specified topologies.

  Parameters

  • ctx: Context

    Active context.

  • Optionaltopology: GPUPrimitiveTopology

    Primitive assembly topology option. Defaults to "triangle-list".

  • OptionalindexFormat: GPUIndexFormat

    Index element data format. Defaults to "uint16".

  • OptionalcullMode: GPUCullMode

    Pipeline culling override.

  • OptionaluseCSM: boolean

  Returns GPURenderPipeline

  The resolved GPURenderPipeline.

id

isDirty

nextPass

type