API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HDRCubeTextureAssetTask

Define a task used by AssetsManager to load HDR cube textures

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new HDRCubeTextureAssetTask(name: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask

  • Creates a new HDRCubeTextureAssetTask object

    Parameters

    • name: string

      defines the name of the task

    • url: string

      defines the location of the file to load

    • size: number

      defines the desired size (the more it increases the longer the generation will be) If the size is omitted this implies you are using a preprocessed cubemap.

    • Optional noMipmap: boolean

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

    • Optional generateHarmonics: boolean

      specifies whether you want to extract the polynomial harmonics during the generation process (default is true)

    • Optional gammaSpace: boolean

      specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space) (default is false)

    • Optional reserved: boolean

      Internal use only

    Returns HDRCubeTextureAssetTask

Properties

gammaSpaceSearch playground for gammaSpace

gammaSpace: boolean

Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space) (default is false)

generateHarmonicsSearch playground for generateHarmonics

generateHarmonics: boolean

Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)

nameSearch playground for name

name: string

Defines the name of the task

noMipmapSearch playground for noMipmap

noMipmap: boolean

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

onErrorSearch playground for onError

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

Callback called when the task is successful

Type declaration

onSuccessSearch playground for onSuccess

onSuccess: (task: HDRCubeTextureAssetTask) => void

Callback called when the task is successful

Type declaration

reservedSearch playground for reserved

reserved: boolean

Internal Use Only

sizeSearch playground for size

size: number

Defines the desired size (the more it increases the longer the generation will be)

textureSearch playground for texture

texture: HDRCubeTexture

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 property
  • Inherited method
  • Static property
  • Static method