Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BasisTextureLoader

Basis texture loader See the ngx3js docs page for details.

Hierarchy

Index

Constructors

constructor

Properties

crossOrigin

crossOrigin: string

The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS. Default is anonymous.

default

'anonymous'

manager

The loadingManager the loader is using. Default is DefaultLoadingManager.

path

path: string

The base path from which the asset will be loaded. Default is the empty string.

default

''

requestHeader

requestHeader: {}

The request header used in HTTP request. See .setRequestHeader. Default is empty object.

default

{}

Type declaration

  • [header: string]: string

resourcePath

resourcePath: string

The base path from which additional resources like textures will be loaded. Default is the empty string.

default

''

transcoderBinary

transcoderBinary: ArrayBuffer

transcoderPath

transcoderPath: string

transcoderPending

transcoderPending: Promise<void>

withCredentials

withCredentials: boolean

Whether the XMLHttpRequest uses credentials. See .setWithCredentials. Default is false.

default:

false

workerConfig

workerConfig: { astcSupported: boolean; dxtSupported: boolean; etcSupported: boolean; format: number; pvrtcSupported: boolean }

Type declaration

  • astcSupported: boolean
  • dxtSupported: boolean
  • etcSupported: boolean
  • format: number
  • pvrtcSupported: boolean

workerLimit

workerLimit: number

workerNextTaskID

workerNextTaskID: number

workerPool

workerPool: object[]

workerSourceURL

workerSourceURL: string

Methods

detectSupport

dispose

  • dispose(): void

load

  • load(url: string, onLoad: (texture: I3JS.CompressedTexture) => void, onProgress?: (event: ProgressEvent<EventTarget>) => void, onError?: (event: ErrorEvent) => void): void
  • Begin loading from url.

    Parameters

    • url: string

      The path or URL to the file.

    • onLoad: (texture: I3JS.CompressedTexture) => void

      Will be called when load completes.

    • Optional onProgress: (event: ProgressEvent<EventTarget>) => void

      Will be called while load progresses.

        • (event: ProgressEvent<EventTarget>): void
        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    • Optional onError: (event: ErrorEvent) => void

      Will be called when load errors.

        • (event: ErrorEvent): void
        • Parameters

          • event: ErrorEvent

          Returns void

    Returns void

loadAsync

  • loadAsync(url: string, onProgress?: (event: ProgressEvent<EventTarget>) => void): Promise<I3JS.CompressedTexture>

setCrossOrigin

setPath

setRequestHeader

setResourcePath

setTranscoderPath

setWithCredentials

setWorkerLimit

Generated using TypeDoc