Interface IMaterialUserData

interface IMaterialUserData {
    __envIntensity?: number;
    __importData?: any;
    __isVariation?: boolean;
    __needsSourceBuffer?: boolean;
    __sourceBlob?: IFile;
    __sourceBuffer?: ArrayBuffer;
    _clearcoatTint?: {
        enableTint?: boolean;
        ior?: number;
        thickness?: number;
        tintColor?: string | number | Color;
    };
    _customBumpMap?: null
    | ITexture;
    _customBumpScale?: number;
    _fragmentClippingExt?: {
        clipEnabled?: boolean;
        clipInvert?: boolean;
        clipMode?: FragmentClippingMode;
        clipParams?: Vector4 | Vector4Tuple;
        clipPosition?: Vector4 | Vector4Tuple;
    };
    _hasCustomBump?: boolean;
    _noiseBumpMat?: {
        bumpNoiseParams?: Vector2
        | Vector2Tuple;
        bumpScale?: number;
        flakeClamp?: number;
        flakeFallOffParams?: Vector3 | Vector3Tuple;
        flakeParams?: Vector4 | Vector4Tuple;
        flakeRadius?: number;
        flakeScale?: number;
        hasBump?: boolean;
        useColorFlakes?: boolean;
    };
    cloneCount?: number;
    cloneId?: string;
    disposeOnIdle?: boolean;
    envMapSlotKey?: string;
    forcedLinearDepth?: number;
    gBufferData?: {
        materialId?: number;
        tonemapEnabled?: boolean;
        [key: string]: any;
    };
    inverseAlphaMap?: boolean;
    pluginsDisabled?: boolean;
    postTonemap?: boolean;
    renderToDepth?: boolean;
    renderToGBuffer?: boolean;
    rootPath?: string;
    runtimeMaterial?: boolean;
    separateEnvMapIntensity?: boolean;
    setDirty?: (options?: IMaterialSetDirtyOptions) => void;
    ssaoCastDisabled?: boolean;
    ssaoDisabled?: boolean;
    sscsDisabled?: boolean;
    ssreflDisabled?: boolean;
    ssreflNonPhysical?: boolean;
    uuid?: string;
    [key: string]: any;
}

Hierarchy (View Summary)

Indexable

  • [key: string]: any

Properties

__envIntensity? __importData? __isVariation? __needsSourceBuffer? __sourceBlob? __sourceBuffer? _clearcoatTint? _customBumpMap? _customBumpScale? _fragmentClippingExt? _hasCustomBump? _noiseBumpMat? cloneCount? cloneId? disposeOnIdle? envMapSlotKey? forcedLinearDepth? gBufferData? inverseAlphaMap? pluginsDisabled? postTonemap? renderToDepth? renderToGBuffer? rootPath? runtimeMaterial? separateEnvMapIntensity? setDirty? ssaoCastDisabled? ssaoDisabled? sscsDisabled? ssreflDisabled? ssreflNonPhysical? uuid?

Properties

Optional__envIntensity

__envIntensity?: number

Optional__importData

__importData?: any

extra arbitrary data saved by the importer that can be used by the plugins (like gltf material variants)

Optional__isVariation

__isVariation?: boolean

Optional__needsSourceBuffer

__needsSourceBuffer?: boolean

This can be set to true in the importer to indicate that the source buffer should be loaded and cached in the userdata during processRaw

Optional__sourceBlob

__sourceBlob?: IFile

Cached source blob for the asset

Optional__sourceBuffer

__sourceBuffer?: ArrayBuffer

Cached source buffer for the asset (only cached when __needsSourceBuffer is set)

Optional_clearcoatTint

_clearcoatTint?: {
    enableTint?: boolean;
    ior?: number;
    thickness?: number;
    tintColor?: string | number | Color;
}

Optional_customBumpMap

_customBumpMap?: null | ITexture

Optional_customBumpScale

_customBumpScale?: number

Optional_fragmentClippingExt

_fragmentClippingExt?: {
    clipEnabled?: boolean;
    clipInvert?: boolean;
    clipMode?: FragmentClippingMode;
    clipParams?: Vector4 | Vector4Tuple;
    clipPosition?: Vector4 | Vector4Tuple;
}

Optional_hasCustomBump

_hasCustomBump?: boolean

Optional_noiseBumpMat

_noiseBumpMat?: {
    bumpNoiseParams?: Vector2 | Vector2Tuple;
    bumpScale?: number;
    flakeClamp?: number;
    flakeFallOffParams?: Vector3 | Vector3Tuple;
    flakeParams?: Vector4 | Vector4Tuple;
    flakeRadius?: number;
    flakeScale?: number;
    hasBump?: boolean;
    useColorFlakes?: boolean;
}

OptionalcloneCount

cloneCount?: number

OptionalcloneId

cloneId?: string

OptionaldisposeOnIdle

disposeOnIdle?: boolean

Automatically dispose material when not used by any object in the scene

Default

true

OptionalenvMapSlotKey

envMapSlotKey?: string

The environment map to use in the RootScene. To use this, object with the material must be in the RootScene, and the key should exist in the RootScene's textureSlots.

only for materials that have envMap

OptionalforcedLinearDepth

forcedLinearDepth?: number

Force a depth value in GBuffer. This is useful to force center values like 0 to the depth.

OptionalgBufferData

gBufferData?: {
    materialId?: number;
    tonemapEnabled?: boolean;
    [key: string]: any;
}

See GBufferPlugin

Type declaration

  • [key: string]: any
  • OptionalmaterialId?: number
  • OptionaltonemapEnabled?: boolean

    Default

    true

OptionalinverseAlphaMap

inverseAlphaMap?: boolean

OptionalpluginsDisabled

pluginsDisabled?: boolean

General flag to disable multiple plugins on the material at once, like SSAO, SSR, Bloom etc.

OptionalpostTonemap

postTonemap?: boolean

Deprecated

Use postTonemap.tonemapEnabled instead. This is kept because used in old files.

OptionalrenderToDepth

renderToDepth?: boolean

Same as renderToGBuffer but for depth only, not normal or flags etc

OptionalrenderToGBuffer

renderToGBuffer?: boolean

OptionalrootPath

rootPath?: string

OptionalruntimeMaterial

runtimeMaterial?: boolean

See MaterialManager.dispose as BaseGroundPlugin._refreshMaterial

OptionalseparateEnvMapIntensity

separateEnvMapIntensity?: boolean

Flag to tell the scene to prefer material.envMapIntensity over scene.envMapIntensity only for materials that have envMapIntensity

OptionalsetDirty

setDirty?: (options?: IMaterialSetDirtyOptions) => void

Deprecated

OptionalssaoCastDisabled

ssaoCastDisabled?: boolean

Cast SSAO on other objects. if casting is not working when this is false, ensure render to depth is true, like for transparent objects

OptionalssaoDisabled

ssaoDisabled?: boolean

Disable SSAOPlugin for this material.

OptionalsscsDisabled

sscsDisabled?: boolean

For SSCSPlugin

OptionalssreflDisabled

ssreflDisabled?: boolean

For SSRPlugin

OptionalssreflNonPhysical

ssreflNonPhysical?: boolean

For SSRPlugin

Optionaluuid

uuid?: string

Settings

Member Visibility

On This Page

Properties