OptionalpOnLoad: Nullable<() => void>OptionalpOnError: Nullable<(message?: string, esception?: any) => void>Protected_Protected_Protected_Protected Optional_Protected_Protected_Protected_Protected_Protected_Protected_With compliant hardware and browser (supporting anisotropic filtering) this defines the level of anisotropic filtering in the texture. The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
Define the current state of the loading sequence when in delayed load mode.
Define the display name of the texture, which is used as tree item name of the dedicated node in the inspector
Sets this property to true to avoid deformations when rotating the texture with non-uniform scaling
List of inspectable custom properties (used by the Inspector)
Is Z inverted in the texture (useful in a cube texture).
Define if the texture is a render target.
Intensity or strength of the texture. It is commonly used by materials to fine tune the intensity of the texture
Gets or sets an object used to store user defined information.
Define the name of the texture.
An event triggered when the texture is disposed.
Observable triggered once the texture has been loaded.
Gets or sets a boolean indicating that the texture should try to reduce shader code if there is no UV manipulation. (ie. when texture.getTextureMatrix().isIdentityAs3x2() returns true)
For internal use only. Please do not use.
Get the polynomial representation of the texture data. This is mainly use as a fast way to recover IBL Diffuse irradiance data.
Define an offset on the texture to rotate around the u coordinates of the UVs The angle is defined in radians.
Gets or sets the unique id of the texture
Define an offset on the texture to offset the u coordinates of the UVs
Define the url of the texture.
Defines the center of rotation (U)
Define an offset on the texture to scale the u coordinates of the UVs
Define an offset on the texture to rotate around the v coordinates of the UVs The angle is defined in radians.
Define an offset on the texture to offset the v coordinates of the UVs
Defines the center of rotation (V)
Define an offset on the texture to scale the v coordinates of the UVs
Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture) The angle is defined in radians.
| Value | Type | Description |
|---|---|---|
| 0 | CLAMP_ADDRESSMODE | |
| 1 | WRAP_ADDRESSMODE | |
| 2 | MIRROR_ADDRESSMODE |
Defines the center of rotation (W)
Static ReadonlyBILINEAR_Bilinear is mag = linear and min = linear and no mip
Static ReadonlyCLAMP_Texture is not repeating outside of 0..1 UVs
Static ReadonlyCUBIC_Cubic coordinates mode
StaticDEFAULT_Default anisotropic filtering level for the application. It is set to 4 as a good tradeoff between perf and quality.
Static ReadonlyEQUIRECTANGULAR_Equirectangular coordinates mode
Static ReadonlyEXPLICIT_Explicit coordinates mode
Static ReadonlyFIXED_Equirectangular Fixed Mirrored coordinates mode
Static ReadonlyFIXED_Equirectangular Fixed coordinates mode
StaticForceGets or sets a general boolean used to indicate that texture buffers must be saved as part of the serialization process. If no buffer exists, one will be created as base64 string from the internal webgl data.
Static ReadonlyINVCUBIC_Inverse Cubic coordinates mode
Static ReadonlyLINEAR_mag = linear and min = linear and mip = none
Static ReadonlyLINEAR_Trilinear is mag = linear and min = linear and mip = linear
Static ReadonlyLINEAR_Bilinear is mag = linear and min = linear and mip = nearest
Static ReadonlyLINEAR_mag = linear and min = nearest and mip = none
Static ReadonlyLINEAR_mag = linear and min = nearest and mip = linear
Static ReadonlyLINEAR_mag = linear and min = nearest and mip = nearest
Static ReadonlyMIRROR_Texture is repeating and mirrored
Static ReadonlyNEAREST_mag = nearest and min = linear and mip = none
Static ReadonlyNEAREST_mag = nearest and min = linear and mip = linear
Static ReadonlyNEAREST_mag = nearest and min = linear and mip = nearest
Static ReadonlyNEAREST_mag = nearest and min = nearest and mip = none
Static ReadonlyNEAREST_nearest is mag = nearest and min = nearest and mip = linear
Static ReadonlyNEAREST_mag = nearest and min = nearest and mip = nearest
Static ReadonlyNEAREST_nearest is mag = nearest and min = nearest and no mip
StaticOnThis observable will notify when any texture had a loading error
Static ReadonlyPLANAR_Planar coordinates mode
Static ReadonlyPROJECTION_Projection coordinates mode
StaticSerializeGets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
Static ReadonlySKYBOX_Inverse Cubic coordinates mode
Static ReadonlySPHERICAL_Spherical coordinates mode
Static ReadonlyTRILINEAR_Trilinear is mag = linear and min = linear and mip = linear
StaticUseGets or sets a boolean which defines if the texture url must be build from the serialized URL instead of just using the name and loading them side by side with the scene file
Static ReadonlyWRAP_Texture is repeating outside of 0..1 UVs
Get if the texture can rescale.
Define the UV channel to use starting from 0 and defaulting to 0. This is part of the texture as textures usually maps to one uv set.
How a texture is mapped. Unused in thin texture mode.
How a texture is mapped.
| Value | Type | Description |
|---|---|---|
| 0 | EXPLICIT_MODE | |
| 1 | SPHERICAL_MODE | |
| 2 | PLANAR_MODE | |
| 3 | CUBIC_MODE | |
| 4 | PROJECTION_MODE | |
| 5 | SKYBOX_MODE | |
| 6 | INVCUBIC_MODE | |
| 7 | EQUIRECTANGULAR_MODE | |
| 8 | FIXED_EQUIRECTANGULAR_MODE | |
| 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE |
If a loading error occurred this object will be populated with information about the error.
Define if the texture contains data in gamma space (most of the png/jpg aside bump). HDR texture are usually stored in linear space. This only impacts the PBR and Background materials
Defines if the alpha value should be determined via the rgb values. If true the luminance of the pixel might be used to find the corresponding alpha value.
Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
In case a better definition than spherical harmonics is required for the diffuse part of the environment. You can set the irradiance texture to rely on a texture instead of the spherical approach. This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
Define if the texture is preventing a material to render or not. If not and the texture is not ready, the engine will use a default black texture instead.
Is the texture preventing material to render while loading. If false, a default texture will be used instead of the loading one during the preparation step.
Define if the texture is a cube texture or if false a 2d texture.
Define if the texture is a cube texture or if false a 2d texture.
Gets or sets whether or not the texture contains RGBD data.
With prefiltered texture, defined if the specular generation is based on a linear ramp. By default we are using a log2 of the linear roughness helping to keep a better resolution for average roughness values.
Was there any loading error?
With prefiltered texture, defined the offset used during the prefiltering steps.
With prefiltered texture, defined the scale used during the prefiltering steps.
Returns the texture mime type if it was defined by a loader (undefined else)
Are mip maps generated for this texture or not.
Callback triggered when the texture has been disposed. Kept for back compatibility, you can use the onDisposeObservable instead.
Get the current sampling mode associated with the texture.
Get the texture underlying format (RGB, RGBA...)
Get the texture underlying type (INT, FLOAT...)
Define the unique id of the texture in the scene.
| Value | Type | Description |
|---|---|---|
| 0 | CLAMP_ADDRESSMODE | |
| 1 | WRAP_ADDRESSMODE | |
| 2 | MIRROR_ADDRESSMODE |
| Value | Type | Description |
|---|---|---|
| 0 | CLAMP_ADDRESSMODE | |
| 1 | WRAP_ADDRESSMODE | |
| 2 | MIRROR_ADDRESSMODE |
| Value | Type | Description |
|---|---|---|
| 0 | CLAMP_ADDRESSMODE | |
| 1 | WRAP_ADDRESSMODE | |
| 2 | MIRROR_ADDRESSMODE |
| Value | Type | Description |
|---|---|---|
| 0 | CLAMP_ADDRESSMODE | |
| 1 | WRAP_ADDRESSMODE | |
| 2 | MIRROR_ADDRESSMODE |
Protected_Indicates that textures need to be re-calculated for all materials
Dispose the texture and release its associated resources.
Force recomputation of spherical polynomials. Can be useful if you generate a cubemap multiple times (from a probe for eg) and you need the proper polynomials each time
Get the base size of the texture. It can be different from the size if the texture has been resized for POT for instance
the base size
Get the current class name of the texture useful for serialization or dynamic coding.
"Texture"
Get the underlying lower level texture from Babylon.
the internal texture
Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
The reflection texture transform
Gets a suitable rotate/transform matrix when the texture is used for refraction. There's a separate function from getReflectionTextureMatrix because refraction requires a special configuration of the matrix in right-handed mode.
The refraction matrix
Get the scene the texture belongs to.
the scene or null if undefined
Get the size of the texture.
the texture size.
Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
the transform matrix of the texture.
Get if the texture is ready to be used (downloaded, converted, mip mapped...).
true if fully ready
Get if the texture is ready to be consumed (either it is ready or it is not blocking)
true if ready, not blocking or if there was an error loading the texture
Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer. This will returns an RGBA array buffer containing either in values (0-255) or float values (0-1) depending of the underlying buffer type. Note that you can use GetTextureDataAsync instead, which will also support reading from a compressed texture (by rendering it to an intermediate RGBA texture and retrieving the bytes from it).
OptionalfaceIndex: number
defines the face of the texture to read (in case of cube texture)
Optionallevel: number
defines the LOD level of the texture to read (in case of Mip Maps)
Optionalbuffer: Nullable<ArrayBufferView<ArrayBufferLike>>
defines a user defined buffer to fill with data (can be null)
OptionalflushRenderer: boolean
true to flush the renderer from the pending commands before reading the pixels
OptionalnoDataConversion: boolean
false to convert the data to Uint8Array (if texture type is UNSIGNED_BYTE) or to Float32Array (if texture type is anything but UNSIGNED_BYTE). If true, the type of the generated buffer (if buffer==null) will depend on the type of the texture
Optionalx: number
defines the region x coordinates to start reading from (default to 0)
Optionaly: number
defines the region y coordinates to start reading from (default to 0)
Optionalwidth: number
defines the region width to read from (default to the texture size at level)
Optionalheight: number
defines the region width to read from (default to the texture size at level)
The Array buffer promise containing the pixels data.
Release and destroy the underlying lower level texture aka internalTexture.
Scales the texture if is canRescale()
the resize factor we want to use to rescale
Serialize the texture to a JSON representation we can easily use in the respective Parse function.
The JSON representation of the texture
Return a string representation of the texture.
the texture as a string
Update the sampling mode of the texture. Default is Trilinear mode.
| Value | Type | Description |
|---|---|---|
| 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
| 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
| 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
| 4 | NEAREST_NEAREST_MIPNEAREST | |
| 5 | NEAREST_LINEAR_MIPNEAREST | |
| 6 | NEAREST_LINEAR_MIPLINEAR | |
| 7 | NEAREST_LINEAR | |
| 8 | NEAREST_NEAREST | |
| 9 | LINEAR_NEAREST_MIPNEAREST | |
| 10 | LINEAR_NEAREST_MIPLINEAR | |
| 11 | LINEAR_LINEAR | |
| 12 | LINEAR_NEAREST |
mag: magnification filter (close to the viewer) min: minification filter (far from the viewer) mip: filter used between mip map levels
Define the new sampling mode of the texture
OptionalgenerateMipMaps: boolean
Define if the texture should generate mip maps or not. Default is false.
Update the url (and optional buffer) of this texture if url was null during construction.
the url of the texture
Optionalbuffer: Nullable<the buffer of the texture (defaults to null)
OptionalonLoad: () => void
callback called when the texture is loaded (defaults to null)
OptionalforcedExtension: string
defines the extension to use to pick the right loader
StaticCreateCreates a texture from its base 64 representation.
Define the base64 payload without the data: prefix
Define the name of the texture in the scene useful fo caching purpose for instance
Define the scene the texture should belong to
OptionalnoMipmapOrOptions: boolean | ITextureCreationOptions
defines if the texture will require mip maps or not or set of all options to create the texture
OptionalinvertY: boolean
define if the texture needs to be inverted on the y axis during loading
OptionalsamplingMode: number
define the sampling mode we want for the texture while fetching from it (Texture.NEAREST_SAMPLINGMODE...)
OptionalonLoad: Nullable<() => void>
define a callback triggered when the texture has been loaded
OptionalonError: Nullable<() => void>
define a callback triggered when an error occurred during the loading session
Optionalformat: number
define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
OptionalcreationFlags: number
specific flags to use when creating the texture (Constants.TEXTURE_CREATIONFLAG_STORAGE for storage textures, for eg)
OptionalforcedExtension: string
defines the extension to use to pick the right loader
the created texture
StaticLoadCreates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
Define the name of the texture in the scene useful fo caching purpose for instance
define the buffer to load the texture from in case the texture is loaded from a buffer representation
Define the scene the texture should belong to
OptionaldeleteBuffer: boolean
define if the buffer we are loading the texture from should be deleted after load
OptionalnoMipmapOrOptions: boolean | ITextureCreationOptions
defines if the texture will require mip maps or not or set of all options to create the texture
OptionalinvertY: boolean
define if the texture needs to be inverted on the y axis during loading
OptionalsamplingMode: number
define the sampling mode we want for the texture while fetching from it (Texture.NEAREST_SAMPLINGMODE...)
OptionalonLoad: Nullable<() => void>
define a callback triggered when the texture has been loaded
OptionalonError: Nullable<(message?: string, exception?: any) => void>
define a callback triggered when an error occurred during the loading session
Optionalformat: number
define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
OptionalcreationFlags: number
specific flags to use when creating the texture (Constants.TEXTURE_CREATIONFLAG_STORAGE for storage textures, for eg)
OptionalforcedExtension: string
defines the extension to use to pick the right loader
the created texture
StaticParseParse the JSON representation of a texture in order to recreate the texture in the given scene.
Define the JSON representation of the texture
Define the scene the parsed texture should be instantiated in
Define the root url of the parsing sequence in the case of relative dependencies
The parsed texture if successful
StaticWhenHelper function to be called back once a list of texture contains only ready textures.
Define the list of textures to wait for
Define the callback triggered once the entire list will be ready
Define the list of animation attached to the texture.