Class Source

Represents the data Source of a texture.

See

Constructors

constructor

Properties

isSource id data dataReady uuid version

Accessors

needsUpdate

Methods

toJSON

Constructors

constructor

  • new Source(data): Source

  • Create a new instance of Source

    Parameters

    • data: any

      The data definition of a texture. Default null

    Returns Source

Properties

ReadonlyisSource

isSource: true

Flag to check if a given object is of type Source.

Remarks

This is a constant value

Default Value

true

Readonlyid

id: number

data

data: any

The actual data of a texture.

Remarks

The type of this property depends on the texture that uses this instance.

dataReady

dataReady: boolean

This property is only relevant when .needsUpdate is set to true and provides more control on how
texture data should be processed.
When dataReady is set to false, the engine performs the memory allocation (if necessary) but does not
transfer the data into the GPU memory.

Default

true

uuid

uuid: string

UUID of this object instance.

Remarks

This gets automatically assigned and shouldn't be edited.

version

version: number

This starts at 0 and counts how many times .needsUpdate is set to true.

Remarks

Expects a Integer

Default Value

0

Accessors

needsUpdate

  • set needsUpdate(value): void

  • When the property is set to true, the engine allocates the memory for the texture (if necessary) and triggers
    the actual texture upload to the GPU next time the source is used.

    Parameters

    • value: boolean

    Returns void

Methods

toJSON

  • toJSON(meta?): {}

  • Convert the data Source to three.js JSON Object/Scene format.

    Parameters

    • Optionalmeta: string | {}

      Optional object containing metadata.

    Returns {}

    Settings

    Member Visibility

    On This Page

    constructorisSourceiddatadataReadyuuidversionneedsUpdatetoJSON