Class LUTCubeLoader

A 3D LUT loader that supports the .cube file format.

Based on an implementation by Garrett Johnson: https://github.com/gkjohnson/threejs-sandbox/tree/master/3d-lut

For more details see: https://wwwimages2.adobe.com/content/dam/acom/en/products/speedgrade/cc/pdfs/cube-lut-specification-1.0.pdf

Hierarchy

  • Loader
    • LUTCubeLoader

Constructors

constructor

Properties

crossOrigin manager path requestHeader resourcePath withCredentials DEFAULT_MATERIAL_NAME

Methods

load loadAsync parse setCrossOrigin setPath setRequestHeader setResourcePath setWithCredentials

Constructors

constructor

  • Parameters

    • Optional manager: LoadingManager

    Returns LUTCubeLoader

Properties

crossOrigin

crossOrigin: string

Default

'anonymous'

manager

manager: LoadingManager

path

path: string

Default

''

requestHeader

requestHeader: {
    [header: string]: string;
}

Type declaration

  • [header: string]: string

Default

{}

resourcePath

resourcePath: string

Default

''

withCredentials

withCredentials: boolean

Default

false

Static DEFAULT_MATERIAL_NAME

DEFAULT_MATERIAL_NAME: string

Methods

load

  • Loads a LUT.

    Parameters

    • url: string

      The URL of the CUBE-file.

    • Optional onLoad: Function

      A callback that receives the loaded lookup texture.

    • Optional onProgress: Function

      A progress callback that receives the XMLHttpRequest instance.

    • Optional onError: Function

      An error callback that receives the URL of the file that failed to load.

    Returns Promise<LookupTexture>

    A promise that returns the lookup texture.

loadAsync

  • Parameters

    • url: string
    • Optional onProgress: ((event) => void)
        • (event): void

        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    Returns Promise<unknown>

parse

  • Parses the given data.

    Parameters

    • input: string

      The LUT data.

    Returns LookupTexture

    The lookup texture.

    Throws

    Fails if the data is invalid.

setCrossOrigin

  • Parameters

    • crossOrigin: string

    Returns LUTCubeLoader

setPath

setRequestHeader

  • Parameters

    • requestHeader: {
          [header: string]: string;
      }
      • [header: string]: string

    Returns LUTCubeLoader

setResourcePath

  • Parameters

    • resourcePath: string

    Returns LUTCubeLoader

setWithCredentials

  • Parameters

    • value: boolean

    Returns LUTCubeLoader

Settings

Member Visibility

Theme

On This Page