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?: Vector2Tuple | Vector2;
        bumpScale?: number;
        flakeClamp?: number;
        flakeFallOffParams?: Vector3 | Vector3Tuple;
        flakeParams?: Vector4 | Vector4Tuple;
        flakeRadius?: number;
        flakeScale?: number;
        hasBump?: boolean;
        useColorFlakes?: boolean;
    };
    cloneCount?: number;
    cloneId?: string;
    disposeOnIdle?: boolean;
    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?) => void);
    ssaoCastDisabled?: boolean;
    ssaoDisabled?: boolean;
    sscsDisabled?: boolean;
    ssreflDisabled?: boolean;
    ssreflNonPhysical?: boolean;
    uuid?: string;
    [key: string]: any;
}

Hierarchy (view full)

Indexable

[key: string]: any

Properties

__envIntensity? __importData? __isVariation? __needsSourceBuffer? __sourceBlob? __sourceBuffer? _clearcoatTint? _customBumpMap? _customBumpScale? _fragmentClippingExt? _hasCustomBump? _noiseBumpMat? cloneCount? cloneId? disposeOnIdle? 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;
}

Type declaration

  • Optional enableTint?: boolean
  • Optional ior?: number
  • Optional thickness?: number
  • Optional 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;
}

Type declaration

Optional _hasCustomBump

_hasCustomBump?: boolean

Optional _noiseBumpMat

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

Type declaration

  • Optional bumpNoiseParams?: Vector2Tuple | Vector2
  • Optional bumpScale?: number
  • Optional flakeClamp?: number
  • Optional flakeFallOffParams?: Vector3 | Vector3Tuple
  • Optional flakeParams?: Vector4 | Vector4Tuple
  • Optional flakeRadius?: number
  • Optional flakeScale?: number
  • Optional hasBump?: boolean
  • Optional useColorFlakes?: boolean

Optional cloneCount

cloneCount?: number

Optional cloneId

cloneId?: string

Optional disposeOnIdle

disposeOnIdle?: boolean

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

Default

true

Optional forcedLinearDepth

forcedLinearDepth?: number

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

Optional gBufferData

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

See GBufferPlugin

Type declaration

  • [key: string]: any
  • Optional materialId?: number
  • Optional tonemapEnabled?: boolean

    Default

    true

Optional inverseAlphaMap

inverseAlphaMap?: boolean

Optional pluginsDisabled

pluginsDisabled?: boolean

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

Optional postTonemap

postTonemap?: boolean

Deprecated

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

Optional renderToDepth

renderToDepth?: boolean

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

Optional renderToGBuffer

renderToGBuffer?: boolean

Optional rootPath

rootPath?: string

Optional runtimeMaterial

runtimeMaterial?: boolean

See MaterialManager.dispose as BaseGroundPlugin._refreshMaterial

Optional separateEnvMapIntensity

separateEnvMapIntensity?: boolean

Optional setDirty

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

Type declaration

Deprecated

Optional ssaoCastDisabled

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

Optional ssaoDisabled

ssaoDisabled?: boolean

Disable SSAOPlugin for this material.

Optional sscsDisabled

sscsDisabled?: boolean

For SSCSPlugin

Optional ssreflDisabled

ssreflDisabled?: boolean

For SSRPlugin

Optional ssreflNonPhysical

ssreflNonPhysical?: boolean

For SSRPlugin

Optional uuid

uuid?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc