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

    Interface SemanticMaterial

    Mutable material data bound to one immutable MaterialDefinition.

    Ordinary parameter and texture changes advance revision but never alter the definition, resource layout, supported pass roles or shader topology. A topology change requires a new instance created with another definition.

    interface SemanticMaterial {
        ambient: MaterialTextureValue;
        anisotropyMap: Texture<TextureImageSource> | null;
        anisotropyRotation: number;
        anisotropyStrength: number;
        attenuationColor: Color;
        attenuationDistance: number;
        attributes: MaterialBindingMap;
        baseColor: Color;
        baseColorMap: Texture<TextureImageSource> | null;
        brdfLUT: Texture<TextureImageSource> | null;
        className: string;
        clearcoatFactor: number;
        clearcoatMap: Texture<TextureImageSource> | null;
        clearcoatNormalMap: Texture<TextureImageSource> | null;
        clearcoatNormalScale: number;
        clearcoatRoughnessFactor: number;
        clearcoatRoughnessMap: Texture<TextureImageSource> | null;
        compositing: MaterialCompositing;
        coverage: MaterialCoverage;
        definition: MaterialDefinition;
        diffuse: MaterialTextureValue;
        diffuseEnvIntensity: number;
        diffuseEnvMap: MaterialTexture | null;
        diffuseEnvSphereHarmonics3: SphericalHarmonics3 | null;
        diffuseTransmissionColor: Color;
        diffuseTransmissionColorMap: Texture<TextureImageSource> | null;
        diffuseTransmissionFactor: number;
        diffuseTransmissionMap: Texture<TextureImageSource> | null;
        emissionFactor: Color;
        glossiness: number;
        id: string;
        ior: number;
        iridescenceFactor: number;
        iridescenceIor: number;
        iridescenceMap: Texture<TextureImageSource> | null;
        iridescenceThicknessMap: Texture<TextureImageSource> | null;
        iridescenceThicknessMaximum: number;
        iridescenceThicknessMinimum: number;
        isMaterialInstance: true;
        lightMap: Texture<TextureImageSource> | null;
        materialId: number;
        metallic: number;
        metallicMap: Texture<TextureImageSource> | null;
        metallicRoughnessMap: Texture<TextureImageSource> | null;
        name: string | null;
        occlusionMap: Texture<TextureImageSource> | null;
        occlusionStrength: number;
        reflectivity: number;
        refractivity: number;
        refractRatio: number;
        roughness: number;
        roughnessMap: Texture<TextureImageSource> | null;
        sheenColor: Color;
        sheenColorMap: Texture<TextureImageSource> | null;
        sheenRoughness: number;
        sheenRoughnessMap: Texture<TextureImageSource> | null;
        shininess: number;
        specular: MaterialTextureValue;
        specularEnvIntensity: number;
        specularEnvMap: MaterialTexture | null;
        specularEnvMatrix: Matrix4 | null;
        specularGlossinessMap: Texture<TextureImageSource> | null;
        subsurfaceFactor: number;
        subsurfaceProfile: { radius: readonly [number, number, number] } | null;
        subsurfaceThickness: number;
        thicknessFactor: number;
        thicknessMap: Texture<TextureImageSource> | null;
        transmissionFactor: number;
        transmissionMap: Texture<TextureImageSource> | null;
        uniformBlocks: Record<string, UniformBuffer>;
        uniforms: MaterialBindingMap;
        userData: unknown;
        get forwardQueue(): "transparent" | "opaque";
        get isTransparent(): boolean;
        get lightType(): string;
        get normalScale(): number;
        set normalScale(value: number): void;
        get opacity(): number;
        set opacity(value: number): void;
        get requiresOpaqueSceneTexture(): boolean;
        get revision(): number;
        get temporalReactiveFactor(): number;
        set temporalReactiveFactor(value: number): void;
        get transparencyClass(): | "opaque"
        | "custom"
        | "weighted-blended"
        | "additive"
        | "sorted-alpha"
        | "transmission";
        destroyTextures(): void;
        getAttributeData(
            name: string,
            mesh: Mesh,
            programInfo: ProgramBindingInfo,
        ): unknown;
        getAttributeInfo(name: string): MaterialBindingInfo;
        getInstancedUniforms(): readonly InstancedUniform[];
        getRenderOption(option?: ShaderOptions): ShaderOptions;
        getTextures(): readonly MaterialTexture[];
        getTextureSlot(name: string): MaterialTextureSlotBinding | null;
        getUniformData(
            name: string,
            mesh: Mesh,
            programInfo: ProgramBindingInfo,
        ): unknown;
        getUniformInfo(name: string): MaterialBindingInfo;
        invalidateData(): void;
        setTextureSlot(
            name: string,
            value: Texture<unknown> | MaterialTextureSlotInput | null,
        ): void;
        [property: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [property: string]: unknown
    Index
    ambient anisotropyMap anisotropyRotation anisotropyStrength attenuationColor attenuationDistance attributes baseColor baseColorMap brdfLUT className clearcoatFactor clearcoatMap clearcoatNormalMap clearcoatNormalScale clearcoatRoughnessFactor clearcoatRoughnessMap compositing coverage definition diffuse diffuseEnvIntensity diffuseEnvMap diffuseEnvSphereHarmonics3 diffuseTransmissionColor diffuseTransmissionColorMap diffuseTransmissionFactor diffuseTransmissionMap emissionFactor glossiness id ior iridescenceFactor iridescenceIor iridescenceMap iridescenceThicknessMap iridescenceThicknessMaximum iridescenceThicknessMinimum isMaterialInstance lightMap materialId metallic metallicMap metallicRoughnessMap name occlusionMap occlusionStrength reflectivity refractivity refractRatio roughness roughnessMap sheenColor sheenColorMap sheenRoughness sheenRoughnessMap shininess specular specularEnvIntensity specularEnvMap specularEnvMatrix specularGlossinessMap subsurfaceFactor subsurfaceProfile subsurfaceThickness thicknessFactor thicknessMap transmissionFactor transmissionMap uniformBlocks uniforms userData
    forwardQueue isTransparent lightType normalScale opacity requiresOpaqueSceneTexture revision temporalReactiveFactor transparencyClass
    destroyTextures getAttributeData getAttributeInfo getInstancedUniforms getRenderOption getTextures getTextureSlot getUniformData getUniformInfo invalidateData setTextureSlot
    ambient: MaterialTextureValue
    anisotropyMap: Texture<TextureImageSource> | null
    anisotropyRotation: number
    anisotropyStrength: number
    attenuationColor: Color
    attenuationDistance: number
    attributes: MaterialBindingMap = {}
    baseColor: Color
    baseColorMap: Texture<TextureImageSource> | null
    brdfLUT: Texture<TextureImageSource> | null
    className: string = 'MaterialInstance'
    clearcoatFactor: number
    clearcoatMap: Texture<TextureImageSource> | null
    clearcoatNormalMap: Texture<TextureImageSource> | null
    clearcoatNormalScale: number
    clearcoatRoughnessFactor: number
    clearcoatRoughnessMap: Texture<TextureImageSource> | null
    compositing: MaterialCompositing
    coverage: MaterialCoverage
    definition: MaterialDefinition
    diffuse: MaterialTextureValue
    diffuseEnvIntensity: number
    diffuseEnvMap: MaterialTexture | null
    diffuseEnvSphereHarmonics3: SphericalHarmonics3 | null
    diffuseTransmissionColor: Color

    Linear transmitted-light RGB, in [0, 1] per channel and independent of base color.

    diffuseTransmissionColorMap: Texture<TextureImageSource> | null

    Initial transmitted RGB texture; the active texture-slot encoding defaults to sRGB.

    diffuseTransmissionFactor: number

    Fraction of dielectric diffuse light transmitted to the opposite hemisphere, in [0, 1].

    diffuseTransmissionMap: Texture<TextureImageSource> | null

    Initial linear alpha-channel diffuse transmission factor texture.

    emissionFactor: Color
    glossiness: number
    id: string
    ior: number
    iridescenceFactor: number
    iridescenceIor: number
    iridescenceMap: Texture<TextureImageSource> | null
    iridescenceThicknessMap: Texture<TextureImageSource> | null
    iridescenceThicknessMaximum: number
    iridescenceThicknessMinimum: number
    isMaterialInstance: true
    lightMap: Texture<TextureImageSource> | null
    materialId: number
    metallic: number
    metallicMap: Texture<TextureImageSource> | null
    metallicRoughnessMap: Texture<TextureImageSource> | null
    name: string | null
    occlusionMap: Texture<TextureImageSource> | null
    occlusionStrength: number
    reflectivity: number
    refractivity: number
    refractRatio: number
    roughness: number
    roughnessMap: Texture<TextureImageSource> | null
    sheenColor: Color

    Linear cloth sheen RGB reflectance, in [0, 1] per channel.

    sheenColorMap: Texture<TextureImageSource> | null

    Initial sheen RGB texture; the active texture-slot encoding defaults to sRGB.

    sheenRoughness: number

    Unitless perceptual sheen roughness in [0, 1].

    sheenRoughnessMap: Texture<TextureImageSource> | null

    Initial linear alpha-channel sheen roughness texture.

    shininess: number
    specular: MaterialTextureValue
    specularEnvIntensity: number
    specularEnvMap: MaterialTexture | null
    specularEnvMatrix: Matrix4 | null
    specularGlossinessMap: Texture<TextureImageSource> | null
    subsurfaceFactor: number

    Diffuse scattering strength in [0, 1].

    subsurfaceProfile: { radius: readonly [number, number, number] } | null

    Immutable RGB diffusion distances in scene world units, or null without scattering.

    Type Declaration

    • { radius: readonly [number, number, number] }
      • Readonlyradius: readonly [number, number, number]

        Positive red, green and blue diffusion distances in scene world units.

    • null
    subsurfaceThickness: number

    World-space slab bound for diffusion radii and depth rejection, in [0.00001, 10000].

    thicknessFactor: number
    thicknessMap: Texture<TextureImageSource> | null
    transmissionFactor: number
    transmissionMap: Texture<TextureImageSource> | null
    uniformBlocks: Record<string, UniformBuffer> = {}
    uniforms: MaterialBindingMap = {}
    userData: unknown
    • 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 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
    Properties
    ambientanisotropyMapanisotropyRotationanisotropyStrengthattenuationColorattenuationDistanceattributesbaseColorbaseColorMapbrdfLUTclassNameclearcoatFactorclearcoatMapclearcoatNormalMapclearcoatNormalScaleclearcoatRoughnessFactorclearcoatRoughnessMapcompositingcoveragedefinitiondiffusediffuseEnvIntensitydiffuseEnvMapdiffuseEnvSphereHarmonics3diffuseTransmissionColordiffuseTransmissionColorMapdiffuseTransmissionFactordiffuseTransmissionMapemissionFactorglossinessidioriridescenceFactoriridescenceIoriridescenceMapiridescenceThicknessMapiridescenceThicknessMaximumiridescenceThicknessMinimumisMaterialInstancelightMapmaterialIdmetallicmetallicMapmetallicRoughnessMapnameocclusionMapocclusionStrengthreflectivityrefractivityrefractRatioroughnessroughnessMapsheenColorsheenColorMapsheenRoughnesssheenRoughnessMapshininessspecularspecularEnvIntensityspecularEnvMapspecularEnvMatrixspecularGlossinessMapsubsurfaceFactorsubsurfaceProfilesubsurfaceThicknessthicknessFactorthicknessMaptransmissionFactortransmissionMapuniformBlocksuniformsuserData
    Accessors
    Methods