Class TextureAssetTask

Define a task used by AssetsManager to load 2D textures

Hierarchy

AbstractAssetTask
- TextureAssetTask

Implements

ITextureAssetTask<Texture>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

Overrides AbstractAssetTask.constructor
- Defined in .temp/docdirectory/doc.d.ts:65313
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

- (task: TextureAssetTask, message?: string, exception?: any): void
- Parameters
  - task: TextureAssetTask
  - Optional message: string
  - Optional exception: any
  Returns void

onSuccessSearch playground for onSuccess

onSuccess: (task: TextureAssetTask) => void

Callback called when the task is successful

Type declaration

- (task: TextureAssetTask): void
- Parameters
  - task: TextureAssetTask
  Returns void

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 }

Inherited from AbstractAssetTask.errorObject
- Defined in .temp/docdirectory/doc.d.ts:64901
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

Inherited from AbstractAssetTask.isCompleted
- Defined in .temp/docdirectory/doc.d.ts:64893
Get if the task is completed

Returns boolean

taskState

get taskState(): AssetTaskState

Inherited from AbstractAssetTask.taskState
- Defined in .temp/docdirectory/doc.d.ts:64897
Gets the current state of the task

Returns AssetTaskState

Methods

resetSearch playground for reset

reset(): void

Inherited from AbstractAssetTask.reset
- Defined in .temp/docdirectory/doc.d.ts:64930
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

Inherited from AbstractAssetTask.run
- Defined in .temp/docdirectory/doc.d.ts:64918
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

Overrides AbstractAssetTask.runTask
- Defined in .temp/docdirectory/doc.d.ts:65349
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

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

url: string

Optional noMipmap: boolean | undefined

Optional invertY: boolean

Optional samplingMode: number

Returns TextureAssetTask

Properties

invertYSearch playground for invertY

nameSearch playground for name

Optional noMipmapSearch playground for noMipmap

onErrorSearch playground for onError

Type declaration

Parameters

task: TextureAssetTask

Optional message: string

Optional exception: any

Returns void

onSuccessSearch playground for onSuccess

Type declaration

Parameters

task: TextureAssetTask

Returns void

samplingModeSearch playground for samplingMode

textureSearch playground for texture

urlSearch playground for url

Accessors

errorObject

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

Optional exception?: any

Optional message?: string

isCompleted

Returns boolean

taskState

Returns AssetTaskState

Methods

resetSearch playground for reset

Returns void

runSearch playground for run

Parameters

scene: Scene

onSuccess: () => void

Returns void

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

Parameters

Optional message: string

Optional exception: any

Returns void

Returns void

runTaskSearch playground for runTask

Parameters

scene: Scene

onSuccess: () => void

Returns void

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

Parameters

Optional message: string

Optional exception: any

Returns void

Returns void