Hilo3d API - v2.0.0-alpha.9
    Preparing search index...

    Class PBRMaterial

    Physically based standard-surface material with immutable shader topology.

    Hierarchy (View Summary)

    Index
    constructor
    anisotropyMap attenuationColor attributes baseColor baseColorMap brdfLUT className clearcoatMap clearcoatNormalMap clearcoatRoughnessMap compositing coverage decals definition diffuseEnvMap diffuseEnvSphereHarmonics3 diffuseTransmissionColor diffuseTransmissionColorMap diffuseTransmissionMap emission emissionFactor id iridescenceMap iridescenceThicknessMap isMaterialInstance isOcclusionInMetallicRoughnessMap isPBRMaterial isSpecularEnvMapIncludeMipmaps isSpecularGlossiness lightMap materialId metallicMap metallicRoughnessMap name occlusionMap reflectionProbes roughnessMap sheenColor sheenColorMap sheenRoughnessMap specular specularEnvMap specularGlossinessMap subsurfaceProfile thicknessMap transmissionMap uniformBlocks uniforms userData
    anisotropyRotation anisotropyStrength attenuationDistance clearcoatFactor clearcoatNormalScale clearcoatRoughnessFactor diffuseEnvIntensity diffuseTransmissionFactor forwardQueue glossiness ior iridescenceFactor iridescenceIor iridescenceThicknessMaximum iridescenceThicknessMinimum isTransparent lightType metallic normalScale occlusionStrength opacity requiresOpaqueSceneTexture revision roughness sheenRoughness specularEnvIntensity subsurfaceFactor subsurfaceThickness temporalReactiveFactor thicknessFactor transmissionFactor transparencyClass
    destroyTextures getAttributeData getAttributeInfo getInstancedUniforms getRenderOption getTextures getTextureSlot getUniformData getUniformInfo invalidateData setTextureSlot
    anisotropyMap: Texture<unknown> | null
    attenuationColor: Color
    attributes: MaterialBindingMap = {}
    baseColor: Color
    baseColorMap: Texture<unknown> | null
    brdfLUT: Texture<unknown> | null
    className: string = 'PBRMaterial'
    clearcoatMap: Texture<unknown> | null
    clearcoatNormalMap: Texture<unknown> | null
    clearcoatRoughnessMap: Texture<unknown> | null
    compositing: MaterialCompositing
    coverage: MaterialCoverage
    decals: Readonly<PBRDecalOptions> | null

    Immutable decal atlas/membership configuration, or null when no decals are enabled.

    definition: MaterialDefinition
    diffuseEnvMap: MaterialTexture | null
    diffuseEnvSphereHarmonics3: SphericalHarmonics3 | null
    diffuseTransmissionColor: Color

    Linear transmitted-light RGB. Mutating this color requires invalidateData().

    diffuseTransmissionColorMap: Texture<unknown> | null

    Initial diffuse transmission color texture.

    diffuseTransmissionMap: Texture<unknown> | null

    Initial diffuse transmission factor texture, sampled from alpha.

    emission: MaterialTextureValue
    emissionFactor: Color
    id: string
    iridescenceMap: Texture<unknown> | null
    iridescenceThicknessMap: Texture<unknown> | null
    isMaterialInstance: true
    isOcclusionInMetallicRoughnessMap: boolean
    isPBRMaterial: true
    isSpecularEnvMapIncludeMipmaps: boolean
    isSpecularGlossiness: boolean
    lightMap: Texture<unknown> | null
    materialId: number
    metallicMap: Texture<unknown> | null
    metallicRoughnessMap: Texture<unknown> | null
    name: string | null
    occlusionMap: Texture<unknown> | null
    reflectionProbes: readonly ReflectionProbe[]

    Immutable membership of this material's local reflection volumes.

    roughnessMap: Texture<unknown> | null
    sheenColor: Color

    Linear cloth sheen RGB. Mutating this color requires invalidateData().

    sheenColorMap: Texture<unknown> | null

    Initial sheen color texture; use setTextureSlot() for runtime binding updates.

    sheenRoughnessMap: Texture<unknown> | null

    Initial sheen roughness texture, sampled from alpha.

    specular: Color
    specularEnvMap: MaterialTexture | null
    specularGlossinessMap: Texture<unknown> | null
    subsurfaceProfile: SubsurfaceScatteringProfile | null

    Immutable diffusion profile, or null for an ordinary surface.

    thicknessMap: Texture<unknown> | null
    transmissionMap: Texture<unknown> | null
    uniformBlocks: Record<string, UniformBuffer> = {}
    uniforms: MaterialBindingMap = {}
    userData: unknown
    • get diffuseTransmissionFactor(): number

      Diffusely transmitted fraction in [0, 1]; does not change coverage or require scene color.

      Returns number

    • set diffuseTransmissionFactor(value: number): void

      Parameters

      • value: number

      Returns void

    • get forwardQueue(): "transparent" | "opaque"

      Forward renderer queue selected from compositing and pass resource dependencies.

      An unblended transmission surface remains compositionally opaque, but it must execute after the opaque scene copy exists and therefore belongs to the transparent/after-opaque queue.

      Returns "transparent" | "opaque"

    • get isTransparent(): boolean

      Whether the forward pass composites this surface with an existing color attachment.

      Returns boolean

    • get requiresOpaqueSceneTexture(): boolean

      Whether the forward shader samples the opaque scene-color copy.

      Returns boolean

    • get revision(): number

      Monotonic instance-data revision observed independently by each renderer.

      Returns number

    • get subsurfaceThickness(): number

      World-space slab bound for radii and depth rejection, from 0.00001 to 10000 scene units.

      Returns number

    • set subsurfaceThickness(value: number): void

      Parameters

      • value: number

      Returns void

    • get temporalReactiveFactor(): number

      Authored TAA history suppression written by the material's motion-vector pass.

      Returns number

    • set temporalReactiveFactor(value: number): void

      Parameters

      • value: number

      Returns void

    • get transparencyClass(): | "opaque"
      | "custom"
      | "weighted-blended"
      | "additive"
      | "sorted-alpha"
      | "transmission"

      Explicit composition class; transmission always keeps its sorted refraction contract.

      Returns
          | "opaque"
          | "custom"
          | "weighted-blended"
          | "additive"
          | "sorted-alpha"
          | "transmission"

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods