RenderTargetTexture | Babylon.js API documentation

Class RenderTargetTexture

This Helps creating a texture that will be created from a camera in your scene. It is basically a dynamic texture that could be used to create special effects for instance. Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...

Hierarchy (View Summary)

Texture
- RenderTargetTexture

Implements

IRenderTargetTexture

Index

Constructors

constructor

Properties

animations anisotropicFilteringLevel boundingBoxPosition clearColor delayLoadState displayName homogeneousRotationInUVTransform ignoreCameraViewport inspectableCustomProperties invertZ isRenderTarget level metadata name noPrePassRenderer onAfterUnbindObservable onBeforeBindObservable onClearObservable onDisposeObservable onLoadObservable onResizeObservable optimizeUVAllocation reservedDataStore skipInitialClear sphericalPolynomial uAng uniqueId uOffset url uRotationCenter uScale useCameraPostProcesses vAng vOffset vRotationCenter vScale wAng wrapR wRotationCenter BILINEAR_SAMPLINGMODE CLAMP_ADDRESSMODE CUBIC_MODE DEFAULT_ANISOTROPIC_FILTERING_LEVEL EQUIRECTANGULAR_MODE EXPLICIT_MODE FIXED_EQUIRECTANGULAR_MIRRORED_MODE FIXED_EQUIRECTANGULAR_MODE ForceSerializeBuffers INVCUBIC_MODE LINEAR_LINEAR LINEAR_LINEAR_MIPLINEAR LINEAR_LINEAR_MIPNEAREST LINEAR_NEAREST LINEAR_NEAREST_MIPLINEAR LINEAR_NEAREST_MIPNEAREST MIRROR_ADDRESSMODE NEAREST_LINEAR NEAREST_LINEAR_MIPLINEAR NEAREST_LINEAR_MIPNEAREST NEAREST_NEAREST NEAREST_NEAREST_MIPLINEAR NEAREST_NEAREST_MIPNEAREST NEAREST_SAMPLINGMODE OnTextureLoadErrorObservable PLANAR_MODE PROJECTION_MODE REFRESHRATE_RENDER_ONCE REFRESHRATE_RENDER_ONEVERYFRAME REFRESHRATE_RENDER_ONEVERYTWOFRAMES SerializeBuffers SKYBOX_MODE SPHERICAL_MODE TRILINEAR_SAMPLINGMODE UseSerializedUrlIfAny WRAP_ADDRESSMODE

Constructors

constructor

new RenderTargetTexture(
    name: string,
    size: TextureSize | { ratio: number },
    scene?: Nullable<Scene>,
    options?: RenderTargetTextureOptions,
): RenderTargetTexture
Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post process or used a shadow, depth texture...
Parameters
- name: string
  The friendly name of the texture
- size: TextureSize | { ratio: number }
  The size of the RTT (number if square, or {width: number, height:number} or {ratio:} to define a ratio from the main scene)
- Optionalscene: Nullable<Scene>
  The scene the RTT belongs to. Default is the last created scene.
- Optionaloptions: RenderTargetTextureOptions
  The options for creating the render target texture.
Returns RenderTargetTexture
Inherited from Texture.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77021
new RenderTargetTexture(
    name: string,
    size: TextureSize | { ratio: number },
    scene?: Nullable<Scene>,
    generateMipMaps?: boolean,
    doNotChangeAspectRatio?: boolean,
    type?: number,
    isCube?: boolean,
    samplingMode?: number,
    generateDepthBuffer?: boolean,
    generateStencilBuffer?: boolean,
    isMulti?: boolean,
    format?: number,
    delayAllocation?: boolean,
    samples?: number,
    creationFlags?: number,
    noColorAttachment?: boolean,
    useSRGBBuffer?: boolean,
): RenderTargetTexture
Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post process or used a shadow, depth texture...
Parameters
- name: string
  The friendly name of the texture
- size: TextureSize | { ratio: number }
  The size of the RTT (number if square, or {width: number, height:number} or {ratio:} to define a ratio from the main scene)
- Optionalscene: Nullable<Scene>
  The scene the RTT belongs to. Default is the last created scene
- OptionalgenerateMipMaps: boolean
  True (default: false) if mipmaps need to be generated after render
- OptionaldoNotChangeAspectRatio: boolean
  True (default) to not change the aspect ratio of the scene in the RTT
- Optionaltype: number
  The type of the buffer in the RTT (byte (default), half float, float...)
- OptionalisCube: boolean
  True (default: false) if a cube texture needs to be created
- OptionalsamplingMode: number
  The sampling mode to be used with the render target (Trilinear (default), Linear, Nearest...)
- OptionalgenerateDepthBuffer: boolean
  True (default) to generate a depth buffer
- OptionalgenerateStencilBuffer: boolean
  True (default: false) to generate a stencil buffer
- OptionalisMulti: boolean
  True (default: false) if multiple textures need to be created (Draw Buffers)
- Optionalformat: number
  The internal format of the buffer in the RTT (RED, RG, RGB, RGBA (default), ALPHA...)
- OptionaldelayAllocation: boolean
  True (default: false) if the texture allocation should be delayed
- Optionalsamples: number
  Sample count to use when creating the RTT
- OptionalcreationFlags: number
  specific flags to use when creating the texture (e.g., Constants.TEXTURE_CREATIONFLAG_STORAGE for storage textures)
- OptionalnoColorAttachment: boolean
  True (default: false) to indicate that no color target should be created. (e.g., if you only want to write to the depth buffer)
- OptionaluseSRGBBuffer: boolean
  True (default: false) to create a SRGB texture
Returns RenderTargetTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77045

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.

boundingBoxPosition

boundingBoxPosition: Vector3

Gets or sets the center of the bounding box associated with the texture (when in cube mode) It must define where the camera used to render the texture is set

clearColor

clearColor: Color4

Define the clear color of the Render Target if it should be different from the scene.

delayLoadState

delayLoadState: number

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

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

ignoreCameraViewport

ignoreCameraViewport: boolean

Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.

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.

noPrePassRenderer

noPrePassRenderer: boolean

Gets or sets a boolean indicating that the prepass renderer should not be used with this render target

onAfterUnbindObservable

onAfterUnbindObservable: Observable<RenderTargetTexture>

An event triggered when the texture is unbind.

onBeforeBindObservable

onBeforeBindObservable: Observable<RenderTargetTexture>

An event triggered when the texture is unbind.

onClearObservable

onClearObservable: Observable<AbstractEngine>

An event triggered after the texture clear

onDisposeObservable

onDisposeObservable: Observable<BaseTexture>

An event triggered when the texture is disposed.

onLoadObservable

onLoadObservable: Observable<Texture>

Observable triggered once the texture has been loaded.

onResizeObservable

onResizeObservable: Observable<RenderTargetTexture>

An event triggered when the texture is resized.

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)

reservedDataStore

reservedDataStore: any

For internal use only. Please do not use.

skipInitialClear

skipInitialClear: boolean

Skip the initial clear of the rtt at the beginning of the frame render loop

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

useCameraPostProcesses

useCameraPostProcesses: boolean

Define if camera post processes should be use while rendering the texture.

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` `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` `Readonly`REFRESHRATE_RENDER_ONCE

REFRESHRATE_RENDER_ONCE: number

The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.

`Static` `Readonly`REFRESHRATE_RENDER_ONEVERYFRAME

REFRESHRATE_RENDER_ONEVERYFRAME: number

The texture will be rendered every frame and is recommended for dynamic contents.

`Static` `Readonly`REFRESHRATE_RENDER_ONEVERYTWOFRAMES

REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number

The texture will be rendered every 2 frames which could be enough if your dynamic objects are not the central point of your effect and can save a lot of performances.

`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` `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

activeCamera

get activeCamera(): Nullable<Camera>
Define the camera used to render the texture.

Returns Nullable<Camera>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76834
set activeCamera(value: Nullable<Camera>): void
Parameters
- value: Nullable<Camera>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76835

boundingBoxSize

get boundingBoxSize(): Vector3
Returns Vector3
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77001
set boundingBoxSize(value: Vector3): void
Gets or sets the size of the bounding box associated with the texture (when in cube mode) When defined, the cubemap will switch to local mode
Parameters
- value: Vector3
Returns void
See
https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
Example
```
https://www.babylonjs-playground.com/#RNASML
```
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77000

cameraForLOD

get cameraForLOD(): Nullable<Camera>
Define the camera used to calculate the LOD of the objects. If not defined, activeCamera will be used. If not defined nor activeCamera, scene's active camera will be used.

Returns Nullable<Camera>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76840
set cameraForLOD(value: Nullable<Camera>): void
Parameters
- value: Nullable<Camera>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76841

canRescale

get canRescale(): boolean
Get if the texture can be rescaled or not.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77123

coordinatesIndex

get coordinatesIndex(): number
Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79212
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79211

coordinatesMode

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

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

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

currentRefreshId

get currentRefreshId(): number
Gets the current value of the refreshId counter

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

customIsReadyFunction

get customIsReadyFunction(): (
    mesh: AbstractMesh,
    refreshRate: number,
    preWarm?: boolean,
) => boolean
Override the mesh isReady function with your own one.

Returns (mesh: AbstractMesh, refreshRate: number, preWarm?: boolean) => boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76851
set customIsReadyFunction(
    value: (
        mesh: AbstractMesh,
        refreshRate: number,
        preWarm?: boolean,
    ) => boolean,
): void
Parameters
- value: (mesh: AbstractMesh, refreshRate: number, preWarm?: boolean) => boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76852

customRenderFunction

get customRenderFunction(): (
    opaqueSubMeshes: SmartArray<SubMesh>,
    alphaTestSubMeshes: SmartArray<SubMesh>,
    transparentSubMeshes: SmartArray<SubMesh>,
    depthOnlySubMeshes: SmartArray<SubMesh>,
    beforeTransparents?: () => void,
) => void
Override the render function of the texture with your own one.

Returns (
    opaqueSubMeshes: SmartArray<SubMesh>,
    alphaTestSubMeshes: SmartArray<SubMesh>,
    transparentSubMeshes: SmartArray<SubMesh>,
    depthOnlySubMeshes: SmartArray<SubMesh>,
    beforeTransparents?: () => void,
) => void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76856
set customRenderFunction(
    value: (
        opaqueSubMeshes: SmartArray<SubMesh>,
        alphaTestSubMeshes: SmartArray<SubMesh>,
        transparentSubMeshes: SmartArray<SubMesh>,
        depthOnlySubMeshes: SmartArray<SubMesh>,
        beforeTransparents?: () => void,
    ) => void,
): void
Parameters
- value: (
      opaqueSubMeshes: SmartArray<SubMesh>,
      alphaTestSubMeshes: SmartArray<SubMesh>,
      transparentSubMeshes: SmartArray<SubMesh>,
      depthOnlySubMeshes: SmartArray<SubMesh>,
      beforeTransparents?: () => void,
  ) => void
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76857

depthStencilTexture

get depthStencilTexture(): Nullable<InternalTexture>
In case the RTT has been created with a depth texture, get the associated depth texture. Otherwise, return null.

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

disableImageProcessing

get disableImageProcessing(): boolean
If true, the renderer will render all objects without any image processing applied. If false (default value), the renderer will use the current setting of the scene's image processing configuration.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76846
set disableImageProcessing(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76847

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 }
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79396

forceLayerMaskCheck

get forceLayerMaskCheck(): boolean
Force checking the layerMask property even if a custom list of meshes is provided (ie. if renderList is not undefined) (default: false).

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76829
set forceLayerMaskCheck(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76830

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79288
set gammaSpace(gamma: boolean): void
Parameters
- gamma: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79289

getAlphaFromRGB

get getAlphaFromRGB(): boolean
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79195
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79194

getCustomRenderList

get getCustomRenderList(): Nullable<
    (
        layerOrFace: number,
        renderList: Nullable<readonly AbstractMesh[]>,
        renderListLength: number,
    ) => Nullable<AbstractMesh[]>,
>
Use this function to overload the renderList array at rendering time. Return null to render with the current renderList, else return the list of meshes to use for rendering. For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of the cube (if the RTT is a cube, else layerOrFace=0). The renderList passed to the function is the current render list (the one that will be used if the function returns null). The length of this list is passed through renderListLength: don't use renderList.length directly because the array can hold dummy elements!

Returns Nullable<
    (
        layerOrFace: number,
        renderList: Nullable<readonly AbstractMesh[]>,
        renderListLength: number,
    ) => Nullable<AbstractMesh[]>,
>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76814
set getCustomRenderList(
    value: Nullable<
        (
            layerOrFace: number,
            renderList: Nullable<readonly AbstractMesh[]>,
            renderListLength: number,
        ) => Nullable<AbstractMesh[]>,
    >,
): void
Parameters
- value: Nullable<
      (
          layerOrFace: number,
          renderList: Nullable<readonly AbstractMesh[]>,
          renderListLength: number,
      ) => Nullable<AbstractMesh[]>,
  >
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76815

hasAlpha

get hasAlpha(): boolean
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79188
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79187

invertY

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76613

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>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79329
set irradianceTexture(value: Nullable<BaseTexture>): void
Parameters
- value: Nullable<BaseTexture>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79330

is2DArray

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79279
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79280

is3D

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79274
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79275

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76609
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76608

isCube

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79269
set isCube(value: boolean): void
Define if the texture is a cube texture or if false a 2d texture.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79270

isMulti

get isMulti(): boolean
Define if the texture has multiple draw buffers or if false a single draw buffer.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76978

isRGBD

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79293
set isRGBD(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79294

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79322
set linearSpecularLOD(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79323

loadingError

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79392

lodGenerationOffset

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

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79310
set lodGenerationOffset(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79311

lodGenerationScale

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

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79315
set lodGenerationScale(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79316

mimeType

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

Returns undefined | string
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76598

noMipmap

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76550

onAfterRender

set onAfterRender(callback: (faceIndex: number) => void): void
Set a after render callback in the texture. This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
Parameters
- callback: (faceIndex: number) => void
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76907

onAfterRenderObservable

get onAfterRenderObservable(): Observable<number>
An event triggered after rendering the texture

Returns Observable<number>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76901

onAfterUnbind

set onAfterUnbind(callback: () => void): void
Set a after unbind callback in the texture. This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
Parameters
- callback: () => void
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76887

onBeforeRender

set onBeforeRender(callback: (faceIndex: number) => void): void
Set a before render callback in the texture. This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
Parameters
- callback: (faceIndex: number) => void
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76897

onBeforeRenderObservable

get onBeforeRenderObservable(): Observable<number>
An event triggered before rendering the texture

Returns Observable<number>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76891

onClear

set onClear(callback: (Engine: AbstractEngine) => void): void
Set a clear callback in the texture. This has been kept for backward compatibility and use of onClearObservable is recommended.
Parameters
- callback: (Engine: AbstractEngine) => void
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76917

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79373

particleSystemList

get particleSystemList(): Nullable<IParticleSystem[]>
Define the list of particle systems to render in the texture. If not provided, will render all the particle systems of the scene. Note that the particle systems are rendered only if renderParticles is set to true.

Returns Nullable<IParticleSystem[]>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76803
set particleSystemList(value: Nullable<IParticleSystem[]>): void
Parameters
- value: Nullable<IParticleSystem[]>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76804

postProcesses

get postProcesses(): PostProcess[]
Post-processes for this render target

Returns PostProcess[]
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76870

refreshRate

get refreshRate(): number
Define the refresh rate of the texture or the rendering frequency. Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77092
set refreshRate(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77093

renderList

get renderList(): Nullable<AbstractMesh[]>
Use this list to define the list of mesh you want to render.

Returns Nullable<AbstractMesh[]>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76797
set renderList(value: Nullable<AbstractMesh[]>): void
Parameters
- value: Nullable<AbstractMesh[]>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76798

renderListPredicate

get renderListPredicate(): (AbstractMesh: AbstractMesh) => boolean
Use this predicate to dynamically define the list of mesh you want to render. If set, the renderList property will be overwritten.

Returns (AbstractMesh: AbstractMesh) => boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76792
set renderListPredicate(value: (AbstractMesh: AbstractMesh) => boolean): void
Parameters
- value: (AbstractMesh: AbstractMesh) => boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76793

renderParticles

get renderParticles(): boolean
Define if particles should be rendered in your texture (default: true).

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76819
set renderParticles(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76820

renderPassId

get renderPassId(): number
Current render pass id of the render target texture. Note it can change over the rendering as there's a separate id for each face of a cube / each layer of an array layer!

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

renderPassIds

get renderPassIds(): readonly number[]
Gets the render pass ids used by the render target texture. For a single render target the array length will be 1, for a cube texture it will be 6 and for a 2D texture array it will return an array of ids the size of the 2D texture array

Returns readonly number[]
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76964

renderSprites

get renderSprites(): boolean
Define if sprites should be rendered in your texture (default: false).

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76824
set renderSprites(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76825

renderTarget

get renderTarget(): Nullable<RenderTargetWrapper>
Gets the render target wrapper associated with this render target

Returns Nullable<RenderTargetWrapper>
Implementation of IRenderTargetTexture.renderTarget
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76986

renderTargetOptions

get renderTargetOptions(): RenderTargetCreationOptions
Gets render target creation options that were used.

Returns RenderTargetCreationOptions
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76982

samples

get samples(): number
Define the number of samples to use in case of MSAA. It defaults to one meaning no MSAA has been enabled.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77066
set samples(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77067

samplingMode

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

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

textureFormat

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

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

textureType

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

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

uid

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

Returns string
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79345

wrapU

get wrapU(): number
Value Type Description

0 CLAMP_ADDRESSMODE

1 WRAP_ADDRESSMODE

2 MIRROR_ADDRESSMODE

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79239
set wrapU(value: number): void
Value Type Description

0 CLAMP_ADDRESSMODE

1 WRAP_ADDRESSMODE

2 MIRROR_ADDRESSMODE
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79240

wrapV

get wrapV(): number
Value Type Description

0 CLAMP_ADDRESSMODE

1 WRAP_ADDRESSMODE

2 MIRROR_ADDRESSMODE

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79248
set wrapV(value: number): void
Value Type Description

0 CLAMP_ADDRESSMODE

1 WRAP_ADDRESSMODE

2 MIRROR_ADDRESSMODE
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79249

Methods

addPostProcess

addPostProcess(postProcess: PostProcess): void
Adds a post process to the render target rendering passes.
Parameters
- postProcess: PostProcess
  define the post process to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77072

clearPostProcesses

clearPostProcesses(dispose?: boolean): void
Clear all the post processes attached to the render target
Parameters
- Optionaldispose: boolean
  define if the cleared post processes should also be disposed (false by default)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77077

clone

clone(): RenderTargetTexture
Clones the texture.

Returns RenderTargetTexture
the cloned texture
Inherited from Texture.clone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77193

createDepthStencilTexture

createDepthStencilTexture(
    comparisonFunction?: number,
    bilinearFiltering?: boolean,
    generateStencil?: boolean,
    samples?: number,
    format?: number,
    label?: string,
): void
Creates a depth stencil texture. This is only available in WebGL 2 or with the depth texture extension available.
Parameters
- OptionalcomparisonFunction: number
  Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode (default: 0)
- OptionalbilinearFiltering: boolean
  Specifies whether or not bilinear filtering is enable on the texture (default: true)
- OptionalgenerateStencil: boolean
  Specifies whether or not a stencil should be allocated in the texture (default: false)
- Optionalsamples: number
  sample count of the depth/stencil texture (default: 1)
- Optionalformat: number
  format of the depth texture (default: Constants.TEXTUREFORMAT_DEPTH32_FLOAT)
- Optionallabel: string
  defines the label of the texture (for debugging purpose)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77058

disableRescaling

disableRescaling(): void
Don't allow this render target texture to rescale. Mainly used to prevent rescaling by the scene optimizer.

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

dispose

dispose(): void
Dispose the texture and release its associated resources.

Returns void
Inherited from Texture.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77210

disposeFramebufferObjects

disposeFramebufferObjects(): void
This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore

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

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 Texture.forceSphericalPolynomialsRecompute
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79146

freeRenderingGroups

freeRenderingGroups(): void
Clear the info related to rendering groups preventing retention point in material dispose.

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

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 Texture.getBaseSize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76068

getClassName

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

Returns string
"Texture"
Inherited from Texture.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76673

getInternalTexture

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

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

getReflectionTextureMatrix

getReflectionTextureMatrix(): Matrix
Get the texture reflection matrix used to rotate/transform the reflection.

Returns Matrix
the reflection matrix
Inherited from Texture.getReflectionTextureMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77133

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 Texture.getRefractionTextureMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79431

getRenderHeight

getRenderHeight(): number
Gets the actual render height of the texture.

Returns number
the height of the render size
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77110

getRenderLayers

getRenderLayers(): number
Gets the actual number of layers of the texture or, in the case of a 3D texture, return the depth.

Returns number
the number of layers
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77115

getRenderSize

getRenderSize(): number
Gets the actual render size of the texture.

Returns number
the width of the render size
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77100

getRenderWidth

getRenderWidth(): number
Gets the actual render width of the texture.

Returns number
the width of the render size
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77105

getScene

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

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

getSize

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

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

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 Texture.getTextureMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76653

getViewCount

getViewCount(): number
Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)

Returns number
the view count
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77221

isReady

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

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

isReadyForRendering

isReadyForRendering(): boolean
This function will check if the render target texture can be rendered (textures are loaded, shaders are compiled)

Returns boolean
true if all required resources are ready
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77157

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 Texture.isReadyOrNotBlocking
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79436

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 Texture.readPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79484

releaseInternalTexture

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

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

removePostProcess

removePostProcess(postProcess: PostProcess): void
Remove one of the post process from the list of attached post processes to the texture
Parameters
- postProcess: PostProcess
  define the post process to remove from the list
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77082

render

render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void
Renders all the objects from the render list into the texture.
Parameters
- OptionaluseCameraPostProcess: boolean
  Define if camera post processes should be used during the rendering
- OptionaldumpForDebug: boolean
  Define if the rendering result should be dumped (copied) for debugging purpose
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77150

resetRefreshCounter

resetRefreshCounter(): void
Resets the refresh counter of the texture and start bak from scratch. Could be useful to regenerate the texture if it is setup to render only once.

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

resize

resize(size: TextureSize | { ratio: number }): void
Resize the texture to a new desired size. Be careful as it will recreate all the data in the new texture.
Parameters
- size: TextureSize | { ratio: number }
  Define the new size. It can be:
  
  a number for squared texture,
  
  an object containing { width: number, height: number }
  
  or an object containing a ratio { ratio: number }
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77142

scale

scale(ratio: number): void
Resize the texture using a ratio.
Parameters
- ratio: number
  the ratio to apply to the texture size in order to compute the new target size
Returns void
Inherited from Texture.scale
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77128

serialize

serialize(): any
Serialize the texture to a JSON representation we can easily use in the respective Parse function.

Returns any
The JSON representation of the texture
Inherited from Texture.serialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77198

setMaterialForRendering

setMaterialForRendering(
mesh: AbstractMesh | AbstractMesh[],
material?: Material | Material[],
): void
Sets a specific material to be used to render a mesh/a list of meshes in this render target texture
Parameters
- mesh: AbstractMesh | AbstractMesh[]
  mesh or array of meshes
- Optionalmaterial: Material | Material[]
  material or array of materials to use for this render pass. If undefined is passed, no specific material will be used but the regular material instead (mesh.material). It's possible to provide an array of materials to use a different material for each rendering in the case of a cube texture (6 rendering) and a 2D texture array (as many rendering as the length of the array)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76974

setRenderingAutoClearDepthStencil

setRenderingAutoClearDepthStencil(
renderingGroupId: number,
autoClearDepthStencil: boolean,
): void
Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
Parameters
- renderingGroupId: number
  The rendering group id corresponding to its index
- autoClearDepthStencil: boolean
  Automatically clears depth and stencil between groups if true.
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77188

setRenderingOrder

setRenderingOrder(
    renderingGroupId: number,
    opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>,
    alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>,
    transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>,
): void
Overrides the default sort function applied in the rendering group to prepare the meshes. This allowed control for front to back rendering or reversely depending of the special needs.
Parameters
- renderingGroupId: number
  The rendering group id corresponding to its index
- OptionalopaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>
  The opaque queue comparison function use to sort.
- OptionalalphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>
  The alpha test queue comparison function use to sort.
- OptionaltransparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>
  The transparent queue comparison function use to sort.
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:77181

toString

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

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

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 Texture.updateURL
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76641

`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 Texture.CreateFromBase64String
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76701

`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 Texture.LoadFromDataString
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76718

`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 Texture.Parse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76685

`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 Texture.WhenAllReady
- Defined in .temp/typedoc/docdirectory/doc.d.ts:79510

Class RenderTargetTexture

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RenderTargetTexture

Parameters

Returns RenderTargetTexture

Properties

animations

anisotropicFilteringLevel

boundingBoxPosition

clearColor

delayLoadState

displayName

homogeneousRotationInUVTransform

ignoreCameraViewport

inspectableCustomProperties

See

invertZ

isRenderTarget

level

metadata

name

noPrePassRenderer

onAfterUnbindObservable

onBeforeBindObservable

onClearObservable

onDisposeObservable

onLoadObservable

onResizeObservable

optimizeUVAllocation

reservedDataStore

skipInitialClear

sphericalPolynomial

See

uAng

See

uniqueId

uOffset

See

url

uRotationCenter

uScale

See

useCameraPostProcesses

vAng

See

vOffset

See

vRotationCenter

vScale

See

wAng

See

wrapR

wRotationCenter

Static ReadonlyBILINEAR_SAMPLINGMODE

Static ReadonlyCLAMP_ADDRESSMODE

Static ReadonlyCUBIC_MODE

StaticDEFAULT_ANISOTROPIC_FILTERING_LEVEL

Static ReadonlyEQUIRECTANGULAR_MODE

Static ReadonlyEXPLICIT_MODE

Static ReadonlyFIXED_EQUIRECTANGULAR_MIRRORED_MODE

Static ReadonlyFIXED_EQUIRECTANGULAR_MODE

StaticForceSerializeBuffers

Static ReadonlyINVCUBIC_MODE

Static ReadonlyLINEAR_LINEAR

Static ReadonlyLINEAR_LINEAR_MIPLINEAR

Static ReadonlyLINEAR_LINEAR_MIPNEAREST

Static ReadonlyLINEAR_NEAREST

Static ReadonlyLINEAR_NEAREST_MIPLINEAR

Static ReadonlyLINEAR_NEAREST_MIPNEAREST

Static ReadonlyMIRROR_ADDRESSMODE

`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` `Readonly`REFRESHRATE_RENDER_ONCE

`Static` `Readonly`REFRESHRATE_RENDER_ONEVERYFRAME

`Static` `Readonly`REFRESHRATE_RENDER_ONEVERYTWOFRAMES

`Static`SerializeBuffers

`Static` `Readonly`SKYBOX_MODE

`Static` `Readonly`SPHERICAL_MODE

`Static` `Readonly`TRILINEAR_SAMPLINGMODE

`Static`UseSerializedUrlIfAny

`Static` `Readonly`WRAP_ADDRESSMODE

Returns (
opaqueSubMeshes: SmartArray<SubMesh>,
alphaTestSubMeshes: SmartArray<SubMesh>,
transparentSubMeshes: SmartArray<SubMesh>,
depthOnlySubMeshes: SmartArray<SubMesh>,
beforeTransparents?: () => void,
) => void