Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextureAssetTask

Define a task used by AssetsManager to load 2D textures

Hierarchy

Implements

Index

Constructors

constructor

  • new TextureAssetTask(name: string, url: string, noMipmap?: boolean | undefined, invertY?: boolean, samplingMode?: number): TextureAssetTask
  • Creates a new TextureAssetTask object

    Parameters

    • name: string

      defines the name of the task

    • url: string

      defines the location of the file to load

    • Optional noMipmap: boolean | undefined

      defines if mipmap should not be generated (default is false)

    • Optional invertY: boolean

      defines if texture must be inverted on Y axis (default is true)

    • Optional samplingMode: number

      defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)

    Returns TextureAssetTask

Properties

invertYSearch playground for invertY

invertY: boolean

Defines if texture must be inverted on Y axis (default is true)

nameSearch playground for name

name: string

Defines the name of the task

Optional noMipmapSearch playground for noMipmap

noMipmap: boolean | undefined

Defines if mipmap should not be generated (default is false)

onErrorSearch playground for onError

onError: (task: TextureAssetTask, message?: string, exception?: any) => void

Callback called when the task is successful

Type declaration

    • Parameters

      Returns void

onSuccessSearch playground for onSuccess

onSuccess: (task: TextureAssetTask) => void

Callback called when the task is successful

Type declaration

samplingModeSearch playground for samplingMode

samplingMode: number

Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)

textureSearch playground for texture

texture: Texture

Gets the loaded texture

urlSearch playground for url

url: string

Defines the location of the file to load

Accessors

errorObject

  • get errorObject(): { exception?: any; message?: string }
  • Gets the current error object (if task is in error)

    Returns { exception?: any; message?: string }

    • Optional exception?: any
    • Optional message?: string

isCompleted

  • get isCompleted(): boolean

taskState

Methods

resetSearch playground for reset

  • reset(): void
  • Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again. This can be used with failed tasks that have the reason for failure fixed.

    Returns void

runSearch playground for run

  • run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void
  • Execute the current task

    Parameters

    • scene: Scene

      defines the scene where you want your assets to be loaded

    • onSuccess: () => void

      is a callback called when the task is successfully executed

        • (): void
        • Returns void

    • onError: (message?: string, exception?: any) => void

      is a callback called if an error occurs

        • (message?: string, exception?: any): void
        • Parameters

          • Optional message: string
          • Optional exception: any

          Returns void

    Returns void

runTaskSearch playground for runTask

  • runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void
  • Execute the current task

    Parameters

    • scene: Scene

      defines the scene where you want your assets to be loaded

    • onSuccess: () => void

      is a callback called when the task is successfully executed

        • (): void
        • Returns void

    • onError: (message?: string, exception?: any) => void

      is a callback called if an error occurs

        • (message?: string, exception?: any): void
        • Parameters

          • Optional message: string
          • Optional exception: any

          Returns void

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited method
  • Static method