AdvancedDynamicTexture | Babylon.js API documentation

Class AdvancedDynamicTexture

Class used to create texture to support 2D GUI elements

See

https://doc.babylonjs.com/features/featuresDeepDive/gui/gui

Hierarchy (View Summary)

DynamicTexture
- AdvancedDynamicTexture

Index

Constructors

constructor

new AdvancedDynamicTexture(
name: string,
options?: IAdvancedDynamicTextureOptions,
): AdvancedDynamicTexture
Creates a new AdvancedDynamicTexture
Parameters
- name: string
  defines the name of the texture
- Optionaloptions: IAdvancedDynamicTextureOptions
  The options to be used when constructing the ADT
Returns AdvancedDynamicTexture
Overrides DynamicTexture.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150876
new AdvancedDynamicTexture(
    name: string,
    width?: number,
    height?: number,
    scene?: Nullable<Scene>,
    generateMipMaps?: boolean,
    samplingMode?: number,
    invertY?: boolean,
): AdvancedDynamicTexture
Parameters
- name: string
- Optionalwidth: number
- Optionalheight: number
- Optionalscene: Nullable<Scene>
- OptionalgenerateMipMaps: boolean
- OptionalsamplingMode: number
- OptionalinvertY: boolean
Returns AdvancedDynamicTexture
Overrides DynamicTexture.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150877

Properties

animations

animations: Animation[]

Define the list of animation attached to the texture.

anisotropicFilteringLevel

anisotropicFilteringLevel: number

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.

applyYInversionOnUpdate

applyYInversionOnUpdate: boolean

Gets or sets a boolean indicating that the canvas must be reverted on Y when updating the texture

checkPointerEveryFrame

checkPointerEveryFrame: boolean

If set to true, every scene render will trigger a pointer event for the GUI if it is linked to a mesh or has controls linked to a mesh. This will allow you to catch the pointer moving around the GUI due to camera or mesh movements, but it has a performance cost.

delayLoadState

delayLoadState: number

Define the current state of the loading sequence when in delayed load mode.

disablePicking

disablePicking: boolean

A boolean indicating whether controls can be picked/clicked on or not. Defaults to false.

disableTabNavigation

disableTabNavigation: boolean

A boolean indicating whether or not the elements can be navigated to using the tab key. Defaults to false.

displayName

displayName: string

Define the display name of the texture, which is used as tree item name of the dedicated node in the inspector

homogeneousRotationInUVTransform

homogeneousRotationInUVTransform: boolean

Sets this property to true to avoid deformations when rotating the texture with non-uniform scaling

inspectableCustomProperties

inspectableCustomProperties: Nullable<IInspectable[]>

List of inspectable custom properties (used by the Inspector)

See

https://doc.babylonjs.com/toolsAndResources/inspector#extensibility

invertZ

invertZ: boolean

Is Z inverted in the texture (useful in a cube texture).

isRenderTarget

isRenderTarget: boolean

Define if the texture is a render target.

level

level: number

Intensity or strength of the texture. It is commonly used by materials to fine tune the intensity of the texture

metadata

metadata: any

Gets or sets an object used to store user defined information.

name

name: string

Define the name of the texture.

onBeginLayoutObservable

onBeginLayoutObservable: Observable<AdvancedDynamicTexture>

BABYLON.Observable event triggered before layout is evaluated

onBeginRenderObservable

onBeginRenderObservable: Observable<AdvancedDynamicTexture>

BABYLON.Observable event triggered before the texture is rendered

onClipboardObservable

onClipboardObservable: Observable<ClipboardInfo>

BABYLON.Observable event triggered each time an clipboard event is received from the rendering canvas

onControlPickedObservable

onControlPickedObservable: Observable<Control>

BABYLON.Observable event triggered each time a pointer down is intercepted by a control

onDisposeObservable

onDisposeObservable: Observable<BaseTexture>

An event triggered when the texture is disposed.

onEndLayoutObservable

onEndLayoutObservable: Observable<AdvancedDynamicTexture>

BABYLON.Observable event triggered after the layout was evaluated

onEndRenderObservable

onEndRenderObservable: Observable<AdvancedDynamicTexture>

BABYLON.Observable event triggered after the texture was rendered

onGuiReadyObservable

onGuiReadyObservable: Observable<AdvancedDynamicTexture>

BABYLON.Observable that fires when the GUI is ready

onLoadObservable

onLoadObservable: Observable<Texture>

Observable triggered once the texture has been loaded.

optimizeUVAllocation

optimizeUVAllocation: boolean

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)

parseContent

parseContent: (
    serializedObject: any,
    scaleToSize?: boolean,
    urlRewriter?: (url: string) => string,
) => void

Recreate the content of the ADT from a JSON object

Type declaration

- (
      serializedObject: any,
      scaleToSize?: boolean,
      urlRewriter?: (url: string) => string,
  ): void
- Parameters
  - serializedObject: any
    define the JSON serialized object to restore from
  - OptionalscaleToSize: boolean
    defines whether to scale to texture to the saved size
  - OptionalurlRewriter: (url: string) => string
    defines an url rewriter to update urls before sending them to the controls
  Returns void

Deprecated

Please use parseSerializedObject instead

premulAlpha

premulAlpha: boolean

Gets or sets a boolean defining if alpha is stored as premultiplied

reservedDataStore

reservedDataStore: any

For internal use only. Please do not use.

skipBlockEvents

skipBlockEvents: number

If this is set, even when a control is pointer blocker, some events can still be passed through to the scene. Options from values are PointerEventTypes POINTERDOWN, POINTERUP, POINTERMOVE, POINTERWHEEL, POINTERPICK, POINTERTAP, POINTERDOUBLETAP

snippetId

snippetId: string

Snippet ID if the content was created from the snippet server

sphericalPolynomial

sphericalPolynomial: Nullable<SphericalPolynomial>

Get the polynomial representation of the texture data. This is mainly use as a fast way to recover IBL Diffuse irradiance data.

See

https://learnopengl.com/PBR/IBL/Diffuse-irradiance

uAng

uAng: number

Define an offset on the texture to rotate around the u coordinates of the UVs The angle is defined in radians.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/moreMaterials

uniqueId

uniqueId: number

Gets or sets the unique id of the texture

uOffset

uOffset: number

Define an offset on the texture to offset the u coordinates of the UVs

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/moreMaterials#offsetting

url

url: Nullable<string>

Define the url of the texture.

uRotationCenter

uRotationCenter: number

Defines the center of rotation (U)

uScale

uScale: number

Define an offset on the texture to scale the u coordinates of the UVs

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/moreMaterials#tiling

usePointerTapForClickEvent

usePointerTapForClickEvent: boolean

If set to true, the POINTERTAP event type will be used for "click", instead of POINTERUP

`Readonly`useStandalone

useStandalone: boolean

Indicates whether the ADT is used autonomously

vAng

vAng: number

Define an offset on the texture to rotate around the v coordinates of the UVs The angle is defined in radians.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/moreMaterials

vOffset

vOffset: number

Define an offset on the texture to offset the v coordinates of the UVs

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/moreMaterials#offsetting

vRotationCenter

vRotationCenter: number

Defines the center of rotation (V)

vScale

vScale: number

Define an offset on the texture to scale the v coordinates of the UVs

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/moreMaterials#tiling

wAng

wAng: number

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.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/moreMaterials

wrapR

wrapR: number

Value	Type	Description
0	CLAMP_ADDRESSMODE
1	WRAP_ADDRESSMODE
2	MIRROR_ADDRESSMODE

wRotationCenter

wRotationCenter: number

Defines the center of rotation (W)

`Static`AllowGPUOptimizations

AllowGPUOptimizations: boolean

Indicates if some optimizations can be performed in GUI GPU management (the downside is additional memory/GPU texture memory used)

`Static` `Readonly`BILINEAR_SAMPLINGMODE

BILINEAR_SAMPLINGMODE: 2

Bilinear is mag = linear and min = linear and no mip

`Static` `Readonly`CLAMP_ADDRESSMODE

CLAMP_ADDRESSMODE: 0

Texture is not repeating outside of 0..1 UVs

`Static` `Readonly`CUBIC_MODE

CUBIC_MODE: 3

Cubic coordinates mode

`Static`DEFAULT_ANISOTROPIC_FILTERING_LEVEL

DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number

Default anisotropic filtering level for the application. It is set to 4 as a good tradeoff between perf and quality.

`Static` `Readonly`EQUIRECTANGULAR_MODE

EQUIRECTANGULAR_MODE: 7

Equirectangular coordinates mode

`Static` `Readonly`EXPLICIT_MODE

EXPLICIT_MODE: 0

Explicit coordinates mode

`Static` `Readonly`FIXED_EQUIRECTANGULAR_MIRRORED_MODE

FIXED_EQUIRECTANGULAR_MIRRORED_MODE: 9

Equirectangular Fixed Mirrored coordinates mode

`Static` `Readonly`FIXED_EQUIRECTANGULAR_MODE

FIXED_EQUIRECTANGULAR_MODE: 8

Equirectangular Fixed coordinates mode

`Static`ForceSerializeBuffers

ForceSerializeBuffers: boolean

Gets 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` `Readonly`INVCUBIC_MODE

INVCUBIC_MODE: 6

Inverse Cubic coordinates mode

`Static` `Readonly`LINEAR_LINEAR

LINEAR_LINEAR: 2

mag = linear and min = linear and mip = none

`Static` `Readonly`LINEAR_LINEAR_MIPLINEAR

LINEAR_LINEAR_MIPLINEAR: 3

Trilinear is mag = linear and min = linear and mip = linear

`Static` `Readonly`LINEAR_LINEAR_MIPNEAREST

LINEAR_LINEAR_MIPNEAREST: 11

Bilinear is mag = linear and min = linear and mip = nearest

`Static` `Readonly`LINEAR_NEAREST

LINEAR_NEAREST: 12

mag = linear and min = nearest and mip = none

`Static` `Readonly`LINEAR_NEAREST_MIPLINEAR

LINEAR_NEAREST_MIPLINEAR: 10

mag = linear and min = nearest and mip = linear

`Static` `Readonly`LINEAR_NEAREST_MIPNEAREST

LINEAR_NEAREST_MIPNEAREST: 9

mag = linear and min = nearest and mip = nearest

`Static` `Readonly`MIRROR_ADDRESSMODE

MIRROR_ADDRESSMODE: 2

Texture is repeating and mirrored

`Static` `Readonly`NEAREST_LINEAR

NEAREST_LINEAR: 7

mag = nearest and min = linear and mip = none

`Static` `Readonly`NEAREST_LINEAR_MIPLINEAR

NEAREST_LINEAR_MIPLINEAR: 6

mag = nearest and min = linear and mip = linear

`Static` `Readonly`NEAREST_LINEAR_MIPNEAREST

NEAREST_LINEAR_MIPNEAREST: 5

mag = nearest and min = linear and mip = nearest

`Static` `Readonly`NEAREST_NEAREST

NEAREST_NEAREST: 1

mag = nearest and min = nearest and mip = none

`Static` `Readonly`NEAREST_NEAREST_MIPLINEAR

NEAREST_NEAREST_MIPLINEAR: 8

nearest is mag = nearest and min = nearest and mip = linear

`Static` `Readonly`NEAREST_NEAREST_MIPNEAREST

NEAREST_NEAREST_MIPNEAREST: 4

mag = nearest and min = nearest and mip = nearest

`Static` `Readonly`NEAREST_SAMPLINGMODE

NEAREST_SAMPLINGMODE: 1

nearest is mag = nearest and min = nearest and no mip

`Static`OnTextureLoadErrorObservable

OnTextureLoadErrorObservable: Observable<BaseTexture>

This observable will notify when any texture had a loading error

`Static` `Readonly`PLANAR_MODE

PLANAR_MODE: 2

Planar coordinates mode

`Static` `Readonly`PROJECTION_MODE

PROJECTION_MODE: 4

Projection coordinates mode

`Static`SerializeBuffers

SerializeBuffers: boolean

Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process

`Static` `Readonly`SKYBOX_MODE

SKYBOX_MODE: 5

Inverse Cubic coordinates mode

`Static`SnippetUrl

SnippetUrl: string

Define the url to load snippets

`Static` `Readonly`SPHERICAL_MODE

SPHERICAL_MODE: 1

Spherical coordinates mode

`Static` `Readonly`TRILINEAR_SAMPLINGMODE

TRILINEAR_SAMPLINGMODE: 3

Trilinear is mag = linear and min = linear and mip = linear

`Static`UseSerializedUrlIfAny

UseSerializedUrlIfAny: boolean

Gets 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` `Readonly`WRAP_ADDRESSMODE

WRAP_ADDRESSMODE: 1

Texture is repeating outside of 0..1 UVs

Accessors

adjustToEngineHardwareScalingLevel

get adjustToEngineHardwareScalingLevel(): boolean
If set to true, the renderScale will be adjusted automatically to the engine's hardware scaling If this is set to true, manually setting the renderScale will be ignored This is useful when the engine's hardware scaling is set to a value other than 1

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150767
set adjustToEngineHardwareScalingLevel(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150768

background

get background(): string
Gets or sets the background color

Returns string
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150776
set background(value: string): void
Parameters
- value: string
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150777

canRescale

get canRescale(): boolean
Gets the current state of canRescale

Returns boolean
Inherited from BABYLON.DynamicTexture.canRescale
- Defined in .temp/typedoc/docdirectory/doc.d.ts:78960

clipboardData

get clipboardData(): string
Gets or set information about clipboardData

Returns string
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150856
set clipboardData(value: string): void
Parameters
- value: string
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150857

coordinatesIndex

get coordinatesIndex(): number
Returns number
Inherited from BABYLON.DynamicTexture.coordinatesIndex
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79359
set coordinatesIndex(value: number): void
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.
Parameters
- value: number
Returns void
Inherited from BABYLON.DynamicTexture.coordinatesIndex
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79358

coordinatesMode

get coordinatesMode(): number
How a texture is mapped. Unused in thin texture mode.

Returns number
Inherited from BABYLON.DynamicTexture.coordinatesMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79378

set coordinatesMode(value: number): void

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

Parameters

value: number

Returns void

errorObject

get errorObject(): undefined | { exception?: any; message?: string }
If a loading error occurred this object will be populated with information about the error.

Returns undefined | { exception?: any; message?: string }
Inherited from BABYLON.DynamicTexture.errorObject
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79543

focusedControl

get focusedControl(): Nullable<Control>
Gets or sets the current focused control

Returns Nullable<Control>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150846
set focusedControl(control: Nullable<Control>): void
Parameters
- control: Nullable<Control>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150847

gammaSpace

get gammaSpace(): boolean
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

Returns boolean
Inherited from BABYLON.DynamicTexture.gammaSpace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79435
set gammaSpace(gamma: boolean): void
Parameters
- gamma: boolean
Returns void
Inherited from BABYLON.DynamicTexture.gammaSpace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79436

getAlphaFromRGB

get getAlphaFromRGB(): boolean
Returns boolean
Inherited from BABYLON.DynamicTexture.getAlphaFromRGB
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79342
set getAlphaFromRGB(value: boolean): void
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.
Parameters
- value: boolean
Returns void
Inherited from BABYLON.DynamicTexture.getAlphaFromRGB
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79341

hasAlpha

get hasAlpha(): boolean
Returns boolean
Inherited from BABYLON.DynamicTexture.hasAlpha
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79335
set hasAlpha(value: boolean): void
Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
Parameters
- value: boolean
Returns void
Inherited from BABYLON.DynamicTexture.hasAlpha
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79334

idealHeight

get idealHeight(): number
Gets or sets the ideal height used to design controls. The GUI will then rescale everything accordingly

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#adaptive-scaling
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150790
set idealHeight(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150791

idealRatio

get idealRatio(): number
Gets the ratio used when in "ideal mode"

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#adaptive-scaling
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150808

idealWidth

get idealWidth(): number
Gets or sets the ideal width used to design controls. The GUI will then rescale everything accordingly

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#adaptive-scaling
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150783
set idealWidth(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150784

invertY

get invertY(): boolean
Gets a boolean indicating if the texture needs to be inverted on the y axis during loading

Returns boolean
Inherited from BABYLON.DynamicTexture.invertY
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76760

irradianceTexture

get irradianceTexture(): Nullable<BaseTexture>
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).

Returns Nullable<BaseTexture>
Inherited from BABYLON.DynamicTexture.irradianceTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79476
set irradianceTexture(value: Nullable<BaseTexture>): void
Parameters
- value: Nullable<BaseTexture>
Returns void
Inherited from BABYLON.DynamicTexture.irradianceTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79477

is2DArray

get is2DArray(): boolean
Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.

Returns boolean
Inherited from BABYLON.DynamicTexture.is2DArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79426
set is2DArray(value: boolean): void
Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
Parameters
- value: boolean
Returns void
Inherited from BABYLON.DynamicTexture.is2DArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79427

is3D

get is3D(): boolean
Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.

Returns boolean
Inherited from BABYLON.DynamicTexture.is3D
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79421
set is3D(value: boolean): void
Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
Parameters
- value: boolean
Returns void
Inherited from BABYLON.DynamicTexture.is3D
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79422

isBlocking

get isBlocking(): boolean
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.

Returns boolean
Inherited from BABYLON.DynamicTexture.isBlocking
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76756
set isBlocking(value: boolean): void
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.
Parameters
- value: boolean
Returns void
Inherited from BABYLON.DynamicTexture.isBlocking
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76755

isCube

get isCube(): boolean
Define if the texture is a cube texture or if false a 2d texture.

Returns boolean
Inherited from BABYLON.DynamicTexture.isCube
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79416
set isCube(value: boolean): void
Define if the texture is a cube texture or if false a 2d texture.
Parameters
- value: boolean
Returns void
Inherited from BABYLON.DynamicTexture.isCube
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79417

isForeground

get isForeground(): boolean
Gets or sets a boolean indicating if the texture must be rendered in background or foreground when in fullscreen mode

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150851
set isForeground(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150852

isRGBD

get isRGBD(): boolean
Gets or sets whether or not the texture contains RGBD data.

Returns boolean
Inherited from BABYLON.DynamicTexture.isRGBD
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79440
set isRGBD(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from BABYLON.DynamicTexture.isRGBD
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79441

layer

get layer(): Nullable<Layer>
Gets the underlying layer used to render the texture when in fullscreen mode

Returns Nullable<Layer>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150812

linearSpecularLOD

get linearSpecularLOD(): boolean
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.

Returns boolean
Inherited from BABYLON.DynamicTexture.linearSpecularLOD
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79469
set linearSpecularLOD(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from BABYLON.DynamicTexture.linearSpecularLOD
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79470

loadingError

get loadingError(): boolean
Was there any loading error?

Returns boolean
Inherited from BABYLON.DynamicTexture.loadingError
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79539

lodGenerationOffset

get lodGenerationOffset(): number
With prefiltered texture, defined the offset used during the prefiltering steps.

Returns number
Inherited from BABYLON.DynamicTexture.lodGenerationOffset
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79457
set lodGenerationOffset(value: number): void
Parameters
- value: number
Returns void
Inherited from BABYLON.DynamicTexture.lodGenerationOffset
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79458

lodGenerationScale

get lodGenerationScale(): number
With prefiltered texture, defined the scale used during the prefiltering steps.

Returns number
Inherited from BABYLON.DynamicTexture.lodGenerationScale
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79462
set lodGenerationScale(value: number): void
Parameters
- value: number
Returns void
Inherited from BABYLON.DynamicTexture.lodGenerationScale
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79463

mimeType

get mimeType(): undefined | string
Returns the texture mime type if it was defined by a loader (undefined else)

Returns undefined | string
Inherited from BABYLON.DynamicTexture.mimeType
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76745

noMipmap

get noMipmap(): boolean
Are mip maps generated for this texture or not.

Returns boolean
Inherited from BABYLON.DynamicTexture.noMipmap
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76697

numLayoutCalls

get numLayoutCalls(): number
Gets the number of layout calls made the last time the ADT has been rendered

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150707

numRenderCalls

get numRenderCalls(): number
Gets the number of render calls made the last time the ADT has been rendered

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150711

onDispose

set onDispose(callback: () => void): void
Callback triggered when the texture has been disposed. Kept for back compatibility, you can use the onDisposeObservable instead.
Parameters
- callback: () => void
Returns void
Inherited from BABYLON.DynamicTexture.onDispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79520

renderAtIdealSize

get renderAtIdealSize(): boolean
Gets or sets a boolean indicating if adaptive scaling must be used

Returns boolean
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#adaptive-scaling
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150802
set renderAtIdealSize(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150803

renderScale

get renderScale(): number
Gets or sets a number used to scale rendering size (2 means that the texture will be twice bigger). Useful when you want more antialiasing

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150773
set renderScale(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150774

rootContainer

get rootContainer(): Container
Gets the root container control

Returns Container
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150816

samplingMode

get samplingMode(): number
Get the current sampling mode associated with the texture.

Returns number
Inherited from BABYLON.DynamicTexture.samplingMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76221

textureFormat

get textureFormat(): number
Get the texture underlying format (RGB, RGBA...)

Returns number
Inherited from BABYLON.DynamicTexture.textureFormat
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79611

textureType

get textureType(): number
Get the texture underlying type (INT, FLOAT...)

Returns number
Inherited from BABYLON.DynamicTexture.textureType
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79607

uid

get uid(): string
Define the unique id of the texture in the scene.

Returns string
Inherited from BABYLON.DynamicTexture.uid
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79492

useInvalidateRectOptimization

get useInvalidateRectOptimization(): boolean
Gets or sets a boolean indicating if the InvalidateRect optimization should be turned on

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150893
set useInvalidateRectOptimization(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150894

useSmallestIdeal

get useSmallestIdeal(): boolean
Gets or sets a boolean indicating if the smallest ideal value must be used if idealWidth and idealHeight are both set

Returns boolean
See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#adaptive-scaling
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150796
set useSmallestIdeal(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150797

wrapU

get wrapU(): number
Value Type Description

0 CLAMP_ADDRESSMODE

1 WRAP_ADDRESSMODE

2 MIRROR_ADDRESSMODE

Returns number
Inherited from BABYLON.DynamicTexture.wrapU
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79386
set wrapU(value: number): void
Value Type Description

0 CLAMP_ADDRESSMODE

1 WRAP_ADDRESSMODE

2 MIRROR_ADDRESSMODE
Parameters
- value: number
Returns void
Inherited from BABYLON.DynamicTexture.wrapU
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79387

wrapV

get wrapV(): number
Value Type Description

0 CLAMP_ADDRESSMODE

1 WRAP_ADDRESSMODE

2 MIRROR_ADDRESSMODE

Returns number
Inherited from BABYLON.DynamicTexture.wrapV
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79395
set wrapV(value: number): void
Value Type Description

0 CLAMP_ADDRESSMODE

1 WRAP_ADDRESSMODE

2 MIRROR_ADDRESSMODE
Parameters
- value: number
Returns void
Inherited from BABYLON.DynamicTexture.wrapV
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79396

Methods

addControl

addControl(control: Control): AdvancedDynamicTexture
Adds a new control to the root container
Parameters
- control: Control
  defines the control to add
Returns AdvancedDynamicTexture
the current texture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150919

attach

attach(): void
Attach to all scene events required to support pointer events

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150989

attachToMesh

attachToMesh(mesh: AbstractMesh, supportPointerMove?: boolean): void
Connect the texture to a hosting mesh to enable interactions
Parameters
- mesh: AbstractMesh
  defines the mesh to attach to
- OptionalsupportPointerMove: boolean
  defines a boolean indicating if pointer move events must be catched as well
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151023

clear

clear(clearColor?: string): void
Clears the texture
Parameters
- OptionalclearColor: string
  Defines the clear color to use
Returns void
Inherited from DynamicTexture.clear
- Defined in .temp/typedoc/docdirectory/doc.d.ts:78982

clone

clone(newName?: string, attachToMesh?: AbstractMesh): AdvancedDynamicTexture
Clones the ADT. If no mesh is defined, the GUI will be considered as a fullscreen GUI
Parameters
- OptionalnewName: string
  defines the name of the new ADT
- OptionalattachToMesh: AbstractMesh
  defines if the new ADT should be attached to a mesh
Returns AdvancedDynamicTexture
the clone of the ADT
Overrides DynamicTexture.clone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151051

createStyle

createStyle(): Style
Helper function used to create a new style

Returns Style
a new style

See
https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#styles
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150913

dispose

dispose(): void
Release all resources

Returns void
Overrides DynamicTexture.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150937

drawText

drawText(
    text: string,
    x: undefined | null | number,
    y: undefined | null | number,
    font: string,
    color: null | string,
    fillColor: null | string,
    invertY?: boolean,
    update?: boolean,
): void
Draws text onto the texture
Parameters
- text: string
  defines the text to be drawn
- x: undefined | null | number
  defines the placement of the text from the left
- y: undefined | null | number
  defines the placement of the text from the top when invertY is true and from the bottom when false
- font: string
  defines the font to be used with font-style, font-size, font-name
- color: null | string
  defines the color used for the text
- fillColor: null | string
  defines the color for the canvas, use null to not overwrite canvas (this bleands with the background to replace, use the clear function)
- OptionalinvertY: boolean
  defines the direction for the Y axis (default is true - y increases downwards)
- Optionalupdate: boolean
  defines whether texture is immediately update (default is true)
Returns void
Inherited from DynamicTexture.drawText
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79001

executeOnAllControls

executeOnAllControls(
func: (control: Control) => void,
container?: Container,
): void
Function used to execute a function on all controls
Parameters
- func: (control: Control) => void
  defines the function to execute
- Optionalcontainer: Container
  defines the container where controls belong. If null the root container will be used
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150888

forceSphericalPolynomialsRecompute

forceSphericalPolynomialsRecompute(): void
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

Returns void
Inherited from DynamicTexture.forceSphericalPolynomialsRecompute
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79293

getBaseSize

getBaseSize(): ISize
Get the base size of the texture. It can be different from the size if the texture has been resized for POT for instance

Returns ISize
the base size
Inherited from DynamicTexture.getBaseSize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76215

getChildren

getChildren(): Container[]
Returns an array containing the root container. This is mostly used to let the Inspector introspects the ADT

Returns Container[]
an array containing the rootContainer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150822

getClassName

getClassName(): string
Get the current class name of the texture useful for serialization or dynamic coding.

Returns string
"AdvancedDynamicTexture"
Overrides DynamicTexture.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150882

getContext

getContext(): ICanvasRenderingContext
Gets the context of the canvas used by the texture

Returns ICanvasRenderingContext
the canvas context of the dynamic texture
Inherited from DynamicTexture.getContext
- Defined in .temp/typedoc/docdirectory/doc.d.ts:78977

getControlByName

getControlByName(name: string): Nullable<Control>
Will return the first control with the given name
Parameters
- name: string
  defines the name to search for
Returns Nullable<Control>
the first control found or null
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150841

getControlsByType

getControlsByType(typeName: string): Control[]
Will return all controls with the given type name
Parameters
- typeName: string
  defines the type name to search for
Returns Control[]
an array of all controls found
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150835

getDescendants

getDescendants(
directDescendantsOnly?: boolean,
predicate?: (control: Control) => boolean,
): Control[]
Will return all controls that are inside this texture
Parameters
- OptionaldirectDescendantsOnly: boolean
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
- Optionalpredicate: (control: Control) => boolean
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
Returns Control[]
all child controls
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150829

getInternalTexture

getInternalTexture(): Nullable<InternalTexture>
Get the underlying lower level texture from Babylon.

Returns Nullable<InternalTexture>
the internal texture
Inherited from DynamicTexture.getInternalTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76204

getProjectedPosition

getProjectedPosition(position: Vector3, worldMatrix: Matrix): Vector2
Get screen coordinates for a vector3
Parameters
- position: Vector3
  defines the position to project
- worldMatrix: Matrix
  defines the world matrix to use
Returns Vector2
the projected position
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150948

getProjectedPositionWithZ

getProjectedPositionWithZ(position: Vector3, worldMatrix: Matrix): Vector3
Get screen coordinates for a vector3
Parameters
- position: Vector3
  defines the position to project
- worldMatrix: Matrix
  defines the world matrix to use
Returns Vector3
the projected position with Z
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150955

getReflectionTextureMatrix

getReflectionTextureMatrix(): Matrix
Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.

Returns Matrix
The reflection texture transform
Inherited from DynamicTexture.getReflectionTextureMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76805

getRefractionTextureMatrix

getRefractionTextureMatrix(): Matrix
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.

Returns Matrix
The refraction matrix
Inherited from DynamicTexture.getRefractionTextureMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79578

getScene

getScene(): Nullable<Scene>
Get the scene the texture belongs to.

Returns Nullable<Scene>
the scene or null if undefined
Inherited from DynamicTexture.getScene
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79560

getSize

getSize(): ISize
Get the size of the texture.

Returns ISize
the texture size.
Inherited from DynamicTexture.getSize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76209

getTextureMatrix

getTextureMatrix(uBase?: number): Matrix
Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
Parameters
- OptionaluBase: number
  The horizontal base offset multiplier (1 by default)
Returns Matrix
the transform matrix of the texture.
Inherited from DynamicTexture.getTextureMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76800

guiIsReady

guiIsReady(): boolean
Returns boolean
true if all the GUI components are ready to render
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151156

invalidateRect

invalidateRect(
    invalidMinX: number,
    invalidMinY: number,
    invalidMaxX: number,
    invalidMaxY: number,
): void
Invalidates a rectangle area on the gui texture
Parameters
- invalidMinX: number
  left most position of the rectangle to invalidate in the texture
- invalidMinY: number
  top most position of the rectangle to invalidate in the texture
- invalidMaxX: number
  right most position of the rectangle to invalidate in the texture
- invalidMaxY: number
  bottom most position of the rectangle to invalidate in the texture
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150903

isReady

isReady(): boolean
Get if the texture is ready to be used (downloaded, converted, mip mapped...).

Returns boolean
true if fully ready
Inherited from DynamicTexture.isReady
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76195

isReadyOrNotBlocking

isReadyOrNotBlocking(): boolean
Get if the texture is ready to be consumed (either it is ready or it is not blocking)

Returns boolean
true if ready, not blocking or if there was an error loading the texture
Inherited from DynamicTexture.isReadyOrNotBlocking
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79583

markAsDirty

markAsDirty(): void
Marks the texture as dirty forcing a complete update

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150907

moveFocusToControl

moveFocusToControl(control: Control): void
Move the focus to a specific control
Parameters
- control: Control
  defines the control which will receive the focus
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151028

moveToNonOverlappedPosition

moveToNonOverlappedPosition(
    overlapGroup?: number | Control[],
    deltaStep?: number,
    repelFactor?: number,
): void
Moves overlapped controls towards a position where it is not overlapping anymore. Please note that this method alters linkOffsetXInPixels and linkOffsetYInPixels.
Parameters
- OptionaloverlapGroup: number | Control[]
  the overlap group which will be processed or undefined to process all overlap groups
- OptionaldeltaStep: number
  the step size (speed) to reach the target non overlapping position (default 0.1)
- OptionalrepelFactor: number
  how much is the control repelled by other controls
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150933

parseFromSnippetAsync

parseFromSnippetAsync(
    snippetId: string,
    scaleToSize?: boolean,
    urlRewriter?: (url: string) => string,
): Promise<AdvancedDynamicTexture>
Recreate the content of the ADT from a snippet saved by the GUI editor
Parameters
- snippetId: string
  defines the snippet to load
- OptionalscaleToSize: boolean
  defines whether to scale to texture to the saved size
- OptionalurlRewriter: (url: string) => string
  defines an url rewriter to update urls before sending them to the controls
Returns Promise<AdvancedDynamicTexture>
a promise that will resolve on success
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151076

parseFromURLAsync

parseFromURLAsync(
    url: string,
    scaleToSize?: boolean,
    urlRewriter?: (url: string) => string,
): Promise<AdvancedDynamicTexture>
Recreate the content of the ADT from a url json
Parameters
- url: string
  defines the url to load
- OptionalscaleToSize: boolean
  defines whether to scale to texture to the saved size
- OptionalurlRewriter: (url: string) => string
  defines an url rewriter to update urls before sending them to the controls
Returns Promise<AdvancedDynamicTexture>
a promise that will resolve on success
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151093

parseSerializedObject

parseSerializedObject(
    serializedObject: any,
    scaleToSize?: boolean,
    urlRewriter?: (url: string) => string,
): void
Recreate the content of the ADT from a JSON object
Parameters
- serializedObject: any
  define the JSON serialized object to restore from
- OptionalscaleToSize: boolean
  defines whether to scale to texture to the saved size
- OptionalurlRewriter: (url: string) => string
  defines an url rewriter to update urls before sending them to the controls
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151044

pick

pick(x: number, y: number, pi?: Nullable<PointerInfoPre>): void
This function will run a pointer event on this ADT and will trigger any pointer events on any controls This will work on a fullscreen ADT only. For mesh based ADT, simulate pointer events using the scene directly.
Parameters
- x: number
  pointer X on the canvas for the picking
- y: number
  pointer Y on the canvas for the picking
- Optionalpi: Nullable<PointerInfoPre>
  optional pointer information
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150986

readPixels

readPixels(
    faceIndex?: number,
    level?: number,
    buffer?: Nullable<ArrayBufferView>,
    flushRenderer?: boolean,
    noDataConversion?: boolean,
    x?: number,
    y?: number,
    width?: number,
    height?: number,
): Nullable<Promise<ArrayBufferView>>
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.
Parameters
- 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>
  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)
Returns Nullable<Promise<ArrayBufferView>>
The Array buffer promise containing the pixels data.
Inherited from DynamicTexture.readPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79631

registerClipboardEvents

registerClipboardEvents(): void
Register the clipboard Events onto the canvas

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151007

releaseInternalTexture

releaseInternalTexture(): void
Release and destroy the underlying lower level texture aka internalTexture.

Returns void
Inherited from DynamicTexture.releaseInternalTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76250

removeControl

removeControl(control: Control): AdvancedDynamicTexture
Removes a control from the root container
Parameters
- control: Control
  defines the control to remove
Returns AdvancedDynamicTexture
the current texture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:150925

scale

scale(ratio: number): void
Scales the texture
Parameters
- ratio: number
  the scale factor to apply to both width and height
Returns void
Overrides DynamicTexture.scale
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151145

scaleTo

scaleTo(width: number, height: number): void
Resizes the texture
Parameters
- width: number
  the new width
- height: number
  the new height
Returns void
Overrides DynamicTexture.scaleTo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151151

serialize

serialize(): any
Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized

Returns any
a serialized dynamic texture object
Inherited from DynamicTexture.serialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79015

serializeContent

serializeContent(): any
Serializes the entire GUI system

Returns any
an object with the JSON serialized data
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151037

toString

toString(): string
Return a string representation of the texture.

Returns string
the texture as a string
Inherited from DynamicTexture.toString
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79501

unRegisterClipboardEvents

unRegisterClipboardEvents(): void
Unregister the clipboard Events from the canvas

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151011

update

update(
    invertY?: boolean,
    premulAlpha?: boolean,
    allowGPUOptimization?: boolean,
): void
Updates the texture
Parameters
- OptionalinvertY: boolean
  defines the direction for the Y axis (default is true - y increases downwards)
- OptionalpremulAlpha: boolean
  defines if alpha is stored as premultiplied (default is false)
- OptionalallowGPUOptimization: boolean
  true to allow some specific GPU optimizations (subject to engine feature "allowGPUOptimizationsForGUI" being true)
Returns void
Inherited from DynamicTexture.update
- Defined in .temp/typedoc/docdirectory/doc.d.ts:78989

updateSamplingMode

updateSamplingMode(samplingMode: number): void

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

Parameters

samplingMode: number
Define the new sampling mode of the texture

Returns void

updateURL

updateURL(
    url: string,
    buffer?: Nullable<
        | string
        | ArrayBufferView
        | ArrayBuffer
        | Blob
        | ImageBitmap
        | HTMLImageElement,
    >,
    onLoad?: () => void,
    forcedExtension?: string,
): void
Update the url (and optional buffer) of this texture if url was null during construction.
Parameters
- url: string
  the url of the texture
- Optionalbuffer: Nullable<
      | string
      | ArrayBufferView
      | ArrayBuffer
      | Blob
      | ImageBitmap
      | HTMLImageElement,
  >
  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
Returns void
Inherited from DynamicTexture.updateURL
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76788

`Static`CreateForMesh

CreateForMesh(
    mesh: AbstractMesh,
    width?: number,
    height?: number,
    supportPointerMove?: boolean,
    onlyAlphaTesting?: boolean,
    invertY?: boolean,
    materialSetupCallback?: (
        mesh: AbstractMesh,
        uniqueId: string,
        texture: AdvancedDynamicTexture,
        onlyAlphaTesting: boolean,
    ) => void,
    sampling?: number,
): AdvancedDynamicTexture
Creates a new AdvancedDynamicTexture in projected mode (ie. attached to a mesh)
Parameters
- mesh: AbstractMesh
  defines the mesh which will receive the texture
- Optionalwidth: number
  defines the texture width (1024 by default)
- Optionalheight: number
  defines the texture height (1024 by default)
- OptionalsupportPointerMove: boolean
  defines a boolean indicating if the texture must capture move events (true by default)
- OptionalonlyAlphaTesting: boolean
  defines a boolean indicating that alpha blending will not be used (only alpha testing) (false by default)
- OptionalinvertY: boolean
  defines if the texture needs to be inverted on the y axis during loading (true by default)
- OptionalmaterialSetupCallback: (
      mesh: AbstractMesh,
      uniqueId: string,
      texture: AdvancedDynamicTexture,
      onlyAlphaTesting: boolean,
  ) => void
  defines a custom way of creating and setting up the material on the mesh
- Optionalsampling: number
  defines the texture sampling mode (Texture.TRILINEAR_SAMPLINGMODE by default)
Returns AdvancedDynamicTexture
a new AdvancedDynamicTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151114

`Static`CreateForMeshTexture

CreateForMeshTexture(
    mesh: AbstractMesh,
    width?: number,
    height?: number,
    supportPointerMove?: boolean,
    invertY?: boolean,
    sampling?: number,
): AdvancedDynamicTexture
Creates a new AdvancedDynamicTexture in projected mode (ie. attached to a mesh) BUT do not create a new material for the mesh. You will be responsible for connecting the texture
Parameters
- mesh: AbstractMesh
  defines the mesh which will receive the texture
- Optionalwidth: number
  defines the texture width (1024 by default)
- Optionalheight: number
  defines the texture height (1024 by default)
- OptionalsupportPointerMove: boolean
  defines a boolean indicating if the texture must capture move events (true by default)
- OptionalinvertY: boolean
  defines if the texture needs to be inverted on the y axis during loading (true by default)
- Optionalsampling: number
  defines the texture sampling mode (Texture.TRILINEAR_SAMPLINGMODE by default)
Returns AdvancedDynamicTexture
a new AdvancedDynamicTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151126

`Static`CreateFromBase64String

CreateFromBase64String(
    data: string,
    name: string,
    scene: Scene,
    noMipmapOrOptions?: boolean | ITextureCreationOptions,
    invertY?: boolean,
    samplingMode?: number,
    onLoad?: Nullable<() => void>,
    onError?: Nullable<() => void>,
    format?: number,
    creationFlags?: number,
    forcedExtension?: string,
): Texture
Creates a texture from its base 64 representation.
Parameters
- data: string
  Define the base64 payload without the data: prefix
- name: string
  Define the name of the texture in the scene useful fo caching purpose for instance
- scene: Scene
  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
Returns Texture
the created texture
Inherited from DynamicTexture.CreateFromBase64String
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76848

`Static`CreateFullscreenUI

CreateFullscreenUI(
    name: string,
    foreground?: boolean,
    sceneOrOptions?: Nullable<Scene> | IAdvancedDynamicTextureOptions,
    sampling?: number,
    adaptiveScaling?: boolean,
): AdvancedDynamicTexture
Creates a new AdvancedDynamicTexture in fullscreen mode. In this mode the texture will rely on a layer for its rendering. This allows it to be treated like any other layer. As such, if you have a multi camera setup, you can set the layerMask on the GUI as well. LayerMask is set through advancedTexture.layer.layerMask
Parameters
- name: string
  defines name for the texture
- Optionalforeground: boolean
  defines a boolean indicating if the texture must be rendered in foreground (default is true)
- OptionalsceneOrOptions: Nullable<Scene> | IAdvancedDynamicTextureOptions
  defines the hosting scene or options (IAdvancedDynamicTextureOptions)
- Optionalsampling: number
  defines the texture sampling mode (Texture.BILINEAR_SAMPLINGMODE by default)
- OptionaladaptiveScaling: boolean
  defines whether to automatically scale root to match hardwarescaling (false by default)
Returns AdvancedDynamicTexture
a new AdvancedDynamicTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151140

`Static`LoadFromDataString

LoadFromDataString(
    name: string,
    buffer: any,
    scene: Scene,
    deleteBuffer?: boolean,
    noMipmapOrOptions?: boolean | ITextureCreationOptions,
    invertY?: boolean,
    samplingMode?: number,
    onLoad?: Nullable<() => void>,
    onError?: Nullable<(message?: string, exception?: any) => void>,
    format?: number,
    creationFlags?: number,
    forcedExtension?: string,
): Texture
Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
Parameters
- name: string
  Define the name of the texture in the scene useful fo caching purpose for instance
- buffer: any
  define the buffer to load the texture from in case the texture is loaded from a buffer representation
- scene: Scene
  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
Returns Texture
the created texture
Inherited from DynamicTexture.LoadFromDataString
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76865

`Static`Parse

Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>
Parse the JSON representation of a texture in order to recreate the texture in the given scene.
Parameters
- parsedTexture: any
  Define the JSON representation of the texture
- scene: Scene
  Define the scene the parsed texture should be instantiated in
- rootUrl: string
  Define the root url of the parsing sequence in the case of relative dependencies
Returns Nullable<BaseTexture>
The parsed texture if successful
Inherited from DynamicTexture.Parse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76832

`Static`ParseFromFileAsync

ParseFromFileAsync(
    url: string,
    scaleToSize?: boolean,
    appendToAdt?: AdvancedDynamicTexture,
    urlRewriter?: (url: string) => string,
): Promise<AdvancedDynamicTexture>
Recreate the content of the ADT from a url json
Parameters
- url: string
  defines the url to load
- OptionalscaleToSize: boolean
  defines whether to scale to texture to the saved size
- OptionalappendToAdt: AdvancedDynamicTexture
  if provided the snippet will be appended to the adt. Otherwise a fullscreen ADT will be created.
- OptionalurlRewriter: (url: string) => string
  defines an url rewriter to update urls before sending them to the controls
Returns Promise<AdvancedDynamicTexture>
a promise that will resolve on success
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151085

`Static`ParseFromSnippetAsync

ParseFromSnippetAsync(
    snippetId: string,
    scaleToSize?: boolean,
    appendToAdt?: AdvancedDynamicTexture,
    urlRewriter?: (url: string) => string,
): Promise<AdvancedDynamicTexture>
Recreate the content of the ADT from a snippet saved by the GUI editor
Parameters
- snippetId: string
  defines the snippet to load
- OptionalscaleToSize: boolean
  defines whether to scale to texture to the saved size
- OptionalappendToAdt: AdvancedDynamicTexture
  if provided the snippet will be appended to the adt. Otherwise a fullscreen ADT will be created.
- OptionalurlRewriter: (url: string) => string
  defines an url rewriter to update urls before sending them to the controls
Returns Promise<AdvancedDynamicTexture>
a promise that will resolve on success
- Defined in .temp/typedoc/docdirectory/doc.d.ts:151068

`Static`WhenAllReady

WhenAllReady(textures: BaseTexture[], callback: () => void): void
Helper function to be called back once a list of texture contains only ready textures.
Parameters
- textures: BaseTexture[]
  Define the list of textures to wait for
- callback: () => void
  Define the callback triggered once the entire list will be ready
Returns void
Inherited from DynamicTexture.WhenAllReady
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79657

Class AdvancedDynamicTexture

See

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AdvancedDynamicTexture

Parameters

Returns AdvancedDynamicTexture

Properties

animations

anisotropicFilteringLevel

applyYInversionOnUpdate

checkPointerEveryFrame

delayLoadState

disablePicking

disableTabNavigation

displayName

homogeneousRotationInUVTransform

inspectableCustomProperties

See

invertZ

isRenderTarget

level

metadata

name

onBeginLayoutObservable

onBeginRenderObservable

onClipboardObservable

onControlPickedObservable

onDisposeObservable

onEndLayoutObservable

onEndRenderObservable

onGuiReadyObservable

onLoadObservable

optimizeUVAllocation

parseContent

Type declaration

Parameters

Returns void

Deprecated

premulAlpha

reservedDataStore

skipBlockEvents

snippetId

sphericalPolynomial

See

uAng

See

uniqueId

uOffset

See

url

uRotationCenter

uScale

See

usePointerTapForClickEvent

ReadonlyuseStandalone

vAng

See

vOffset

See

vRotationCenter

vScale

See

wAng

See

wrapR

wRotationCenter

StaticAllowGPUOptimizations

Static ReadonlyBILINEAR_SAMPLINGMODE

Static ReadonlyCLAMP_ADDRESSMODE

Static ReadonlyCUBIC_MODE

StaticDEFAULT_ANISOTROPIC_FILTERING_LEVEL

Static ReadonlyEQUIRECTANGULAR_MODE

`Readonly`useStandalone

`Static`AllowGPUOptimizations

`Static` `Readonly`BILINEAR_SAMPLINGMODE

`Static` `Readonly`CLAMP_ADDRESSMODE

`Static` `Readonly`CUBIC_MODE

`Static`DEFAULT_ANISOTROPIC_FILTERING_LEVEL

`Static` `Readonly`EQUIRECTANGULAR_MODE

`Static` `Readonly`EXPLICIT_MODE

`Static` `Readonly`FIXED_EQUIRECTANGULAR_MIRRORED_MODE

`Static` `Readonly`FIXED_EQUIRECTANGULAR_MODE

`Static`ForceSerializeBuffers

`Static` `Readonly`INVCUBIC_MODE

`Static` `Readonly`LINEAR_LINEAR

`Static` `Readonly`LINEAR_LINEAR_MIPLINEAR

`Static` `Readonly`LINEAR_LINEAR_MIPNEAREST

`Static` `Readonly`LINEAR_NEAREST

`Static` `Readonly`LINEAR_NEAREST_MIPLINEAR

`Static` `Readonly`LINEAR_NEAREST_MIPNEAREST

`Static` `Readonly`MIRROR_ADDRESSMODE

`Static` `Readonly`NEAREST_LINEAR

`Static` `Readonly`NEAREST_LINEAR_MIPLINEAR

`Static` `Readonly`NEAREST_LINEAR_MIPNEAREST

`Static` `Readonly`NEAREST_NEAREST

`Static` `Readonly`NEAREST_NEAREST_MIPLINEAR

`Static` `Readonly`NEAREST_NEAREST_MIPNEAREST

`Static` `Readonly`NEAREST_SAMPLINGMODE

`Static`OnTextureLoadErrorObservable

`Static` `Readonly`PLANAR_MODE

`Static` `Readonly`PROJECTION_MODE

`Static`SerializeBuffers

`Static` `Readonly`SKYBOX_MODE

`Static`SnippetUrl

`Static` `Readonly`SPHERICAL_MODE

`Static` `Readonly`TRILINEAR_SAMPLINGMODE

`Static`UseSerializedUrlIfAny

`Static` `Readonly`WRAP_ADDRESSMODE