Small World Engine API Reference - v0.78.00
    Preparing search index...

    Interface StandardMaterialOptions

    Configuration options for StandardMaterial.

    interface StandardMaterialOptions {
        alphaMap?: Texture;
        alphaTest?: number;
        ao?: number;
        aoMap?: Texture;
        attenuationColor?: Color;
        attenuationDistance?: number;
        clearcoat?: number;
        clearcoatMap?: Texture;
        clearcoatNormalMap?: Texture;
        clearcoatRoughness?: number;
        clearcoatRoughnessMap?: Texture;
        color?: Color;
        diffuseMap?: Texture;
        emissiveColor?: Color;
        emissiveIntensity?: number;
        emissiveMap?: Texture;
        envMap?: CubeTexture;
        ior?: number;
        metallic?: number;
        metallicMap?: Texture;
        normalMap?: Texture;
        normalScale?: Vector2D;
        reflectionFresnelBlend?: number;
        reflectionMap?: Texture;
        reflectivity?: number;
        roughness?: number;
        roughnessMap?: Texture;
        sheenColor?: Color;
        sheenColorMap?: Texture;
        sheenRoughness?: number;
        sheenRoughnessMap?: Texture;
        thickness?: number;
        thicknessMap?: Texture;
        time?: number;
        transmission?: number;
        transmissionMap?: Texture;
        transparent?: boolean;
    }
    Index
    alphaMap? alphaTest? ao? aoMap? attenuationColor? attenuationDistance? clearcoat? clearcoatMap? clearcoatNormalMap? clearcoatRoughness? clearcoatRoughnessMap? color? diffuseMap? emissiveColor? emissiveIntensity? emissiveMap? envMap? ior? metallic? metallicMap? normalMap? normalScale? reflectionFresnelBlend? reflectionMap? reflectivity? roughness? roughnessMap? sheenColor? sheenColorMap? sheenRoughness? sheenRoughnessMap? thickness? thicknessMap? time? transmission? transmissionMap? transparent?
    alphaMap?: Texture

    The alpha mask texture map.

    alphaTest?: number

    Alpha cutoff threshold. Fragments with alpha below this value are discarded. Defaults to 0.0.

    ao?: number

    Ambient occlusion factor (0 to 1). Defaults to 1.

    aoMap?: Texture

    Ambient occlusion texture map.

    attenuationColor?: Color

    Volumetric attenuation color. Defaults to white.

    attenuationDistance?: number

    Volumetric attenuation distance. Defaults to 1000.0 (no attenuation).

    clearcoat?: number

    Clearcoat layer intensity (0 to 1). Defaults to 0.0.

    clearcoatMap?: Texture

    Clearcoat factor texture map.

    clearcoatNormalMap?: Texture

    Clearcoat normal map texture.

    clearcoatRoughness?: number

    Clearcoat layer roughness (0 to 1). Defaults to 0.0.

    clearcoatRoughnessMap?: Texture

    Clearcoat roughness texture map.

    color?: Color

    The base color of the material. Defaults to white.

    diffuseMap?: Texture

    The diffuse texture map.

    emissiveColor?: Color

    The emissive color. Defaults to black.

    emissiveIntensity?: number

    The intensity of the emissive light. Defaults to 1.0.

    emissiveMap?: Texture

    The emissive texture map.

    envMap?: CubeTexture

    Environment map for Image-Based Lighting reflections.

    ior?: number

    Index of refraction. Defaults to 1.5.

    metallic?: number

    Metallic factor (0 to 1). Defaults to 0.

    metallicMap?: Texture

    The metallic texture map.

    normalMap?: Texture

    The normal map texture.

    normalScale?: Vector2D

    Scale factor for the normal map to control strength and flip X/Y. Defaults to (1, 1).

    reflectionFresnelBlend?: number

    How much of the planar reflection's strength depends on view angle: 0 = constant strength regardless of angle, 1 = pure Schlick Fresnel (strong only within the last few degrees before a grazing angle, effectively invisible everywhere else -- physically correct for a smooth dielectric, but reads as an on/off switch rather than a gradual falloff to a human observer). Defaults to 0.5, matching the engine's original fixed blend. Lower this for a reflection that should stay legible across a wider range of viewing angles (e.g. a puddle meant to be seen from a normal, not-perfectly-grazing camera angle).

    reflectionMap?: Texture

    Planar reflection map.

    reflectivity?: number

    Planar reflection intensity. Defaults to 1.0.

    roughness?: number

    Roughness factor (0 to 1). Defaults to 0.5.

    roughnessMap?: Texture

    The roughness texture map.

    sheenColor?: Color

    Sheen color for microfiber grazing highlights. Defaults to black (disabled).

    sheenColorMap?: Texture

    Sheen color texture map.

    sheenRoughness?: number

    Sheen roughness (0 to 1). Defaults to 0.0.

    sheenRoughnessMap?: Texture

    Sheen roughness texture map.

    thickness?: number

    Volume thickness factor. Defaults to 0.0.

    thicknessMap?: Texture

    Volume thickness texture map.

    time?: number

    Time parameter for shader animations. Defaults to 0.0.

    transmission?: number

    Transmission factor for specular light transmission (0 to 1). Defaults to 0.0.

    transmissionMap?: Texture

    Transmission factor texture map.

    transparent?: boolean

    Whether the material is transparent. Defaults to false.

    Settings
    Member Visibility

    On This Page
    Properties