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

    Interface PBRMaterialParameters

    interface PBRMaterialParameters {
        anisotropyMap?: PBRMaterialTextureInput;
        anisotropyRotation?: number;
        anisotropyStrength?: number;
        attenuationColor?: Color;
        attenuationDistance?: number;
        baseColor?: Color;
        baseColorMap?: PBRMaterialTextureInput;
        brdfLUT?: Texture<TextureImageSource> | null;
        clearcoatFactor?: number;
        clearcoatMap?: PBRMaterialTextureInput;
        clearcoatNormalMap?: PBRMaterialTextureInput;
        clearcoatNormalScale?: number;
        clearcoatRoughnessFactor?: number;
        clearcoatRoughnessMap?: PBRMaterialTextureInput;
        compositing?: MaterialCompositing;
        coverage?: MaterialCoverage;
        cullMode?: MaterialCullMode;
        decals?: Readonly<PBRDecalOptions>;
        diffuseEnvIntensity?: number;
        diffuseEnvMap?: MaterialTextureSlotInput | MaterialTexture | null;
        diffuseEnvSphereHarmonics3?: SphericalHarmonics3 | null;
        diffuseTransmissionColor?: Color;
        diffuseTransmissionColorMap?: PBRMaterialTextureInput;
        diffuseTransmissionFactor?: number;
        diffuseTransmissionMap?: PBRMaterialTextureInput;
        emission?: MaterialTextureSlotInput | MaterialTextureValue;
        emissionFactor?: Color;
        frontFace?: MaterialFrontFace;
        glossiness?: number;
        ior?: number;
        iridescenceFactor?: number;
        iridescenceIor?: number;
        iridescenceMap?: PBRMaterialTextureInput;
        iridescenceThicknessMap?: PBRMaterialTextureInput;
        iridescenceThicknessMaximum?: number;
        iridescenceThicknessMinimum?: number;
        isOcclusionInMetallicRoughnessMap?: boolean;
        isSpecularEnvMapIncludeMipmaps?: boolean;
        isSpecularGlossiness?: boolean;
        lightMap?: PBRMaterialTextureInput;
        metallic?: number;
        metallicMap?: PBRMaterialTextureInput;
        metallicRoughnessMap?: PBRMaterialTextureInput;
        name?: string | null;
        normalMap?: Texture<unknown> | MaterialTextureSlotInput | null;
        normalScale?: number;
        occlusionMap?: PBRMaterialTextureInput;
        occlusionStrength?: number;
        opacity?: number;
        opacityMap?: Texture<unknown> | MaterialTextureSlotInput | null;
        parallaxMap?: Texture<unknown> | MaterialTextureSlotInput | null;
        reflectionProbes?: readonly ReflectionProbe[];
        roughness?: number;
        roughnessMap?: PBRMaterialTextureInput;
        sheenColor?: Color;
        sheenColorMap?: PBRMaterialTextureInput;
        sheenRoughness?: number;
        sheenRoughnessMap?: PBRMaterialTextureInput;
        specular?: Color;
        specularEnvIntensity?: number;
        specularEnvMap?: MaterialTextureSlotInput | MaterialTexture | null;
        specularGlossinessMap?: PBRMaterialTextureInput;
        state?: Partial<Readonly<MaterialPipelineState>>;
        subsurfaceFactor?: number;
        subsurfaceProfile?: SubsurfaceScatteringProfile;
        subsurfaceThickness?: number;
        temporalReactiveFactor?: number;
        thicknessFactor?: number;
        thicknessMap?: PBRMaterialTextureInput;
        transmissionFactor?: number;
        transmissionMap?: PBRMaterialTextureInput;
        uniformBlocks?: Readonly<
            Record<
                string,
                UniformBuffer<
                    Readonly<Record<string, Std140Type | Std140FieldDefinition>>,
                >,
            >,
        >;
        unlit?: boolean;
        userData?: unknown;
    }

    Hierarchy (View Summary)

    Index
    anisotropyMap? anisotropyRotation? anisotropyStrength? attenuationColor? attenuationDistance? baseColor? baseColorMap? brdfLUT? clearcoatFactor? clearcoatMap? clearcoatNormalMap? clearcoatNormalScale? clearcoatRoughnessFactor? clearcoatRoughnessMap? compositing? coverage? cullMode? decals? diffuseEnvIntensity? diffuseEnvMap? diffuseEnvSphereHarmonics3? diffuseTransmissionColor? diffuseTransmissionColorMap? diffuseTransmissionFactor? diffuseTransmissionMap? emission? emissionFactor? frontFace? glossiness? ior? iridescenceFactor? iridescenceIor? iridescenceMap? iridescenceThicknessMap? iridescenceThicknessMaximum? iridescenceThicknessMinimum? isOcclusionInMetallicRoughnessMap? isSpecularEnvMapIncludeMipmaps? isSpecularGlossiness? lightMap? metallic? metallicMap? metallicRoughnessMap? name? normalMap? normalScale? occlusionMap? occlusionStrength? opacity? opacityMap? parallaxMap? reflectionProbes? roughness? roughnessMap? sheenColor? sheenColorMap? sheenRoughness? sheenRoughnessMap? specular? specularEnvIntensity? specularEnvMap? specularGlossinessMap? state? subsurfaceFactor? subsurfaceProfile? subsurfaceThickness? temporalReactiveFactor? thicknessFactor? thicknessMap? transmissionFactor? transmissionMap? uniformBlocks? unlit? userData?
    anisotropyMap?: PBRMaterialTextureInput
    anisotropyRotation?: number
    anisotropyStrength?: number
    attenuationColor?: Color
    attenuationDistance?: number
    baseColor?: Color
    baseColorMap?: PBRMaterialTextureInput
    brdfLUT?: Texture<TextureImageSource> | null
    clearcoatFactor?: number
    clearcoatMap?: PBRMaterialTextureInput
    clearcoatNormalMap?: PBRMaterialTextureInput
    clearcoatNormalScale?: number
    clearcoatRoughnessFactor?: number
    clearcoatRoughnessMap?: PBRMaterialTextureInput
    compositing?: MaterialCompositing
    coverage?: MaterialCoverage
    cullMode?: MaterialCullMode
    decals?: Readonly<PBRDecalOptions>

    Bounded world-space surface decals; opaque and alpha-masked receivers only.

    diffuseEnvIntensity?: number
    diffuseEnvMap?: MaterialTextureSlotInput | MaterialTexture | null
    diffuseEnvSphereHarmonics3?: SphericalHarmonics3 | null
    diffuseTransmissionColor?: Color

    Linear transmitted-light RGB in [0, 1], independent of baseColor.

    diffuseTransmissionColorMap?: PBRMaterialTextureInput

    Diffusely transmitted RGB texture, decoded from sRGB by default.

    diffuseTransmissionFactor?: number

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

    diffuseTransmissionMap?: PBRMaterialTextureInput

    Linear diffuse transmission factor in the alpha channel.

    emission?: MaterialTextureSlotInput | MaterialTextureValue
    emissionFactor?: Color
    frontFace?: MaterialFrontFace
    glossiness?: number
    ior?: number
    iridescenceFactor?: number
    iridescenceIor?: number
    iridescenceMap?: PBRMaterialTextureInput
    iridescenceThicknessMap?: PBRMaterialTextureInput
    iridescenceThicknessMaximum?: number
    iridescenceThicknessMinimum?: number
    isOcclusionInMetallicRoughnessMap?: boolean
    isSpecularEnvMapIncludeMipmaps?: boolean
    isSpecularGlossiness?: boolean
    lightMap?: PBRMaterialTextureInput
    metallic?: number
    metallicMap?: PBRMaterialTextureInput
    metallicRoughnessMap?: PBRMaterialTextureInput
    name?: string | null
    normalMap?: Texture<unknown> | MaterialTextureSlotInput | null
    normalScale?: number
    occlusionMap?: PBRMaterialTextureInput
    occlusionStrength?: number
    opacity?: number
    opacityMap?: Texture<unknown> | MaterialTextureSlotInput | null
    parallaxMap?: Texture<unknown> | MaterialTextureSlotInput | null
    reflectionProbes?: readonly ReflectionProbe[]

    One or two local specular volumes, blended per pixel with the environment fallback.

    roughness?: number
    roughnessMap?: PBRMaterialTextureInput
    sheenColor?: Color

    Linear sheen RGB in [0, 1]; supplying this value enables the immutable cloth layer.

    sheenColorMap?: PBRMaterialTextureInput

    Sheen RGB texture, decoded from sRGB by default.

    sheenRoughness?: number

    Sheen perceptual roughness in [0, 1], multiplied by the roughness texture alpha.

    sheenRoughnessMap?: PBRMaterialTextureInput

    Linear sheen roughness in the alpha channel.

    specular?: Color
    specularEnvIntensity?: number
    specularEnvMap?: MaterialTextureSlotInput | MaterialTexture | null
    specularGlossinessMap?: PBRMaterialTextureInput
    state?: Partial<Readonly<MaterialPipelineState>>
    subsurfaceFactor?: number

    Diffuse scattering strength in [0, 1], default 1 with a profile and 0 otherwise.

    subsurfaceProfile?: SubsurfaceScatteringProfile

    Immutable diffusion distances in scene world units; requires an enabled subsurface pipeline.

    subsurfaceThickness?: number

    World-space slab bound in [0.00001, 10000]; defaults to three times the maximum radius, capped at 10000.

    temporalReactiveFactor?: number

    Authored TAA history suppression for unstable shading, from zero to one.

    thicknessFactor?: number
    thicknessMap?: PBRMaterialTextureInput
    transmissionFactor?: number
    transmissionMap?: PBRMaterialTextureInput
    uniformBlocks?: Readonly<
        Record<
            string,
            UniformBuffer<
                Readonly<Record<string, Std140Type | Std140FieldDefinition>>,
            >,
        >,
    >

    Registered std140 blocks keyed by their globally stable GLSL block name.

    unlit?: boolean

    Compile the standard surface without lighting.

    userData?: unknown

    Settings
    Member Visibility

    On This Page
    Properties
    anisotropyMapanisotropyRotationanisotropyStrengthattenuationColorattenuationDistancebaseColorbaseColorMapbrdfLUTclearcoatFactorclearcoatMapclearcoatNormalMapclearcoatNormalScaleclearcoatRoughnessFactorclearcoatRoughnessMapcompositingcoveragecullModedecalsdiffuseEnvIntensitydiffuseEnvMapdiffuseEnvSphereHarmonics3diffuseTransmissionColordiffuseTransmissionColorMapdiffuseTransmissionFactordiffuseTransmissionMapemissionemissionFactorfrontFaceglossinessioriridescenceFactoriridescenceIoriridescenceMapiridescenceThicknessMapiridescenceThicknessMaximumiridescenceThicknessMinimumisOcclusionInMetallicRoughnessMapisSpecularEnvMapIncludeMipmapsisSpecularGlossinesslightMapmetallicmetallicMapmetallicRoughnessMapnamenormalMapnormalScaleocclusionMapocclusionStrengthopacityopacityMapparallaxMapreflectionProbesroughnessroughnessMapsheenColorsheenColorMapsheenRoughnesssheenRoughnessMapspecularspecularEnvIntensityspecularEnvMapspecularGlossinessMapstatesubsurfaceFactorsubsurfaceProfilesubsurfaceThicknesstemporalReactiveFactorthicknessFactorthicknessMaptransmissionFactortransmissionMapuniformBlocksunlituserData