Class HDRCubeTextureAssetTask
Hierarchy
-
AbstractAssetTask
- HDRCubeTextureAssetTask
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
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
gamma SpaceSearch playground for gammaSpace
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)
generate HarmonicsSearch playground for generateHarmonics
Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
nameSearch playground for name
Defines the name of the task
no MipmapSearch playground for noMipmap
Defines if mipmaps should not be generated (default is false)
on ErrorSearch playground for onError
Callback called when the task is successful
Type declaration
-
-
Parameters
-
task: HDRCubeTextureAssetTask
-
Optional message: string
-
Optional exception: any
Returns void
-
-
on SuccessSearch playground for onSuccess
Callback called when the task is successful
Type declaration
-
-
Parameters
-
task: HDRCubeTextureAssetTask
Returns void
-
-
reservedSearch playground for reserved
Internal Use Only
sizeSearch playground for size
Defines the desired size (the more it increases the longer the generation will be)
textureSearch playground for texture
Gets the loaded texture
urlSearch playground for url
Defines the location of the file to load
Accessors
error Object
-
Gets the current error object (if task is in error)
Returns { exception?: any; message?: string }
-
Optional exception?: any
-
Optional message?: string
-
is Completed
-
Get if the task is completed
Returns boolean
task State
-
Gets the current state of the task
Returns AssetTaskState
Methods
resetSearch playground for reset
-
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
-
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
-
-
Returns void
-
-
-
onError: (message?: string, exception?: any) => void
is a callback called if an error occurs
-
-
Parameters
-
Optional message: string
-
Optional exception: any
Returns void
-
-
-
Returns void
-
run TaskSearch playground for runTask
-
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
-
-
Returns void
-
-
-
onError: (message?: string, exception?: any) => void
is a callback called if an error occurs
-
-
Parameters
-
Optional message: string
-
Optional exception: any
Returns void
-
-
-
Returns void
-
Define a task used by AssetsManager to load HDR cube textures