ThinEngine | Babylon.js API documentation

Class ThinEngine

The base engine class (root of all engines)

Hierarchy (View Summary)

AbstractEngine
- ThinEngine
  - Engine

Index

Constructors

Properties

activeView adaptToDeviceRatio canvasTabIndex cullBackFaces currentRenderPassId disableContextMenu disableManifestCheck disablePerformanceMonitorInBackground disableUniformBuffers disableVertexArrayObjects enableOfflineSupport enableUnpackFlipYCached forcePOTTextures hasOriginBottomLeft hostInformation inputElement isFullscreen isNDCHalfZRange isPointerLock loadingScreen loadingUIBackgroundColor loadingUIText onAfterShaderCompilationObservable onAfterViewRenderObservable onBeforeShaderCompilationObservable onBeforeTextureInitObservable onBeforeViewRenderObservable onBeginFrameObservable onCanvasBlurObservable onCanvasFocusObservable onCanvasPointerOutObservable onContextLostObservable onContextRestoredObservable onDisposeObservable onEffectErrorObservable onEndFrameObservable onNewSceneAddedObservable onReleaseEffectsObservable onResizeObservable postProcesses premultipliedAlpha preventCacheWipeBetweenFrames renderEvenInBackground scenes skipFrameRender startTime useExactSrgbConversions validateShaderPrograms views _RescalePostProcessFactory audioEngine AudioEngineFactory CollisionsEpsilon ExceptionList OfflineProviderFactory QueueNewFrame

Methods

_createDepthStencilCubeTexture _createImageBitmapFromSource _getInternalFormatFromDepthTextureFormat _getWebGLTextureTypeFromDepthTextureFormat _updateRenderBuffer applyStates areAllComputeEffectsReady areAllEffectsReady attachContextLostEvent attachContextRestoredEvent beginFrame beginOcclusionQuery bindArrayBuffer bindAttachments bindBuffers bindBuffersDirectly bindFramebuffer bindInstancesBuffer bindSamplers bindUniformBlock bindUniformBuffer bindUniformBufferBase bindVertexArrayObject buildTextureLayout cacheStencilState captureGPUFrameTime clear clearInternalTexturesCache computeDispatch computeDispatchIndirect createCanvas createCanvasImage createCanvasPath2D createComputeContext createComputeEffect createComputePipelineContext createCubeTexture createDepthStencilTexture createDrawContext createDynamicTexture createDynamicUniformBuffer createDynamicVertexBuffer createEffect createEffectForParticles createImageBitmap createIndexBuffer createMaterialContext createMultipleRenderTarget createPipelineContext createPrefilteredCubeTexture createQuery createRawCubeTexture createRawCubeTextureFromUrl createRawShaderProgram createRawTexture createRawTexture2DArray createRawTexture3D createRenderPassId createRenderTargetCubeTexture createRenderTargetTexture createShaderProgram createTexture createUniformBuffer createVertexBuffer createVideoElement deleteQuery disableAttributeByIndex disableInstanceAttribute disableInstanceAttributeByName displayLoadingUI dispose draw drawArraysType drawElementsType drawPointClouds drawUnIndexed enableEffect endFrame endOcclusionQuery endTimeQuery enterFullscreen exitFullscreen extractDriverInfo flushFramebuffer generateMipmaps generateMipMapsForCubemap generateMipMapsFramebuffer generateMipMapsMultiFramebuffer getAlphaEquation getAlphaMode getAspectRatio getAttributes getAudioContext getAudioDestination getCaps getClassName getColorWrite getCreationOptions getCurrentRenderPassName getDeltaTime getDepthBuffer getDepthFunction getDepthWrite getError getFontOffset getFps getGlInfo getGPUFrameTimeCounter getHardwareScalingLevel getHostDocument getHostWindow getInfo getInputElement getInputElementClientRect getLoadedTexturesCache getLockstepMaxSteps getQueryResult getRenderHeight getRenderingCanvas getRenderingCanvasClientRect getRenderPassNames getRenderWidth getScreenAspectRatio getStencilBuffer getStencilFunction getStencilFunctionMask getStencilFunctionReference getStencilMask getStencilOperationDepthFail getStencilOperationFail getStencilOperationPass getTimeStep getUniforms getZOffset getZOffsetUnits hideLoadingUI inlineShaderCode isDeterministicLockStep isQueryResultAvailable readPixels recordVertexArrayObject registerView releaseComputeEffects releaseEffects releaseRenderPassId releaseVertexArrayObject resetTextureCache resize resizeImageBitmap resolveFramebuffer resolveMultiFramebuffer restoreDefaultFramebuffer restoreSingleAttachment restoreSingleAttachmentForRenderTarget restoreStencilState runRenderLoop setAlphaConstants setAlphaEquation setAlphaMode setArray setArray2 setArray3 setArray4 setColorWrite setDepthBuffer setDepthFunction setDepthFunctionToGreater setDepthFunctionToGreaterOrEqual setDepthFunctionToLess setDepthFunctionToLessOrEqual setDepthStencilTexture setDepthWrite setFloat setFloat2 setFloat3 setFloat4 setHardwareScalingLevel setInt setInt2 setInt3 setInt4 setIntArray setIntArray2 setIntArray3 setIntArray4 setMatrices setMatrix2x2 setMatrix3x3 setSize setState setStateCullFaceType setStencilBuffer setStencilFunction setStencilFunctionMask setStencilFunctionReference setStencilMask setStencilOperationDepthFail setStencilOperationFail setStencilOperationPass setTexture setTextureArray setTextureFromPostProcess setTextureFromPostProcessOutput setUInt setUInt2 setUInt3 setUInt4 setUIntArray setUIntArray2 setUIntArray3 setUIntArray4 setViewport setZOffset setZOffsetUnits snapshotRenderingReset startTimeQuery stopRenderLoop switchFullscreen unbindAllAttributes unbindAllTextures unBindFramebuffer unbindInstanceAttributes unBindMultiColorAttachmentFramebuffer unRegisterView updateAndBindInstancesBuffer updateArrayBuffer updateDynamicIndexBuffer updateDynamicTexture updateDynamicVertexBuffer updateMultipleRenderTargetTextureSampleCount updateRawCubeTexture updateRawTexture updateRawTexture2DArray updateRawTexture3D updateRenderTargetTextureSampleCount updateTextureData updateTextureDimensions updateTextureSamplingMode updateTextureWrappingMode updateUniformBuffer updateVideoTexture wipeCaches DefaultLoadingScreenFactory isSupported MarkAllMaterialsAsDirty

Constructors

constructor

new ThinEngine(
    canvasOrContext: Nullable<
        | WebGL2RenderingContext
        | WebGLRenderingContext
        | HTMLCanvasElement
        | OffscreenCanvas,
    >,
    antialias?: boolean,
    options?: EngineOptions,
    adaptToDeviceRatio?: boolean,
): ThinEngine
Creates a new engine
Parameters
- canvasOrContext: Nullable<
      | WebGL2RenderingContext
      | WebGLRenderingContext
      | HTMLCanvasElement
      | OffscreenCanvas,
  >
  defines the canvas or WebGL context to use for rendering. If you provide a WebGL context, Babylon.js will not hook events on the canvas (like pointers, keyboards, etc...) so no event observables will be available. This is mostly used when Babylon.js is used as a plugin on a system which already used the WebGL context
- Optionalantialias: boolean
  defines whether anti-aliasing should be enabled (default value is "undefined", meaning that the browser may or may not enable it)
- Optionaloptions: EngineOptions
  defines further options to be sent to the getContext() function
- OptionaladaptToDeviceRatio: boolean
  defines whether to adapt to the device's viewport characteristics (default: false)
Returns ThinEngine
Overrides AbstractEngine.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111917

Properties

activeView

activeView: Nullable<EngineView>

Gets the current engine view

See

https://doc.babylonjs.com/features/featuresDeepDive/scene/multiCanvas

adaptToDeviceRatio

adaptToDeviceRatio: boolean

If set to true zooming in and out in the browser will rescale the hardware-scaling correctly.

canvasTabIndex

canvasTabIndex: number

Gets or sets the tab index to set to the rendering canvas. 1 is the minimum value to set to be able to capture keyboard events

cullBackFaces

cullBackFaces: Nullable<boolean>

Gets or sets a boolean indicating if back faces must be culled. If false, front faces are culled instead (true by default) If non null, this takes precedence over the value from the material

currentRenderPassId

currentRenderPassId: number

Gets or sets the current render pass id

disableContextMenu

disableContextMenu: boolean

Gets or sets a boolean to enable/disable the context menu (right-click) from appearing on the main canvas

disableManifestCheck

disableManifestCheck: boolean

Gets or sets a boolean to enable/disable checking manifest if IndexedDB support is enabled (js will always consider the database is up to date)

disablePerformanceMonitorInBackground

disablePerformanceMonitorInBackground: boolean

Turn this value on if you want to pause FPS computation when in background

disableUniformBuffers

disableUniformBuffers: boolean

Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported

disableVertexArrayObjects

disableVertexArrayObjects: boolean

Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported

enableOfflineSupport

enableOfflineSupport: boolean

Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest

enableUnpackFlipYCached

enableUnpackFlipYCached: boolean

In case you are sharing the context with other applications, it might be interested to not cache the unpack flip y state to ensure a consistent value would be set.

forcePOTTextures

forcePOTTextures: boolean

Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required

`Readonly`hasOriginBottomLeft

hasOriginBottomLeft: boolean

Indicates that the origin of the texture/framebuffer space is the bottom left corner. If false, the origin is top left

hostInformation

hostInformation: HostInformation

Gets information about the current host

inputElement

inputElement: Nullable<HTMLElement>

Gets or sets the HTML element to use for attaching events

isFullscreen

isFullscreen: boolean

Gets a boolean indicating if the engine is currently rendering in fullscreen mode

`Readonly`isNDCHalfZRange

isNDCHalfZRange: boolean

Indicates if the z range in NDC space is 0..1 (value: true) or -1..1 (value: false)

isPointerLock

isPointerLock: boolean

Gets a boolean indicating if the pointer is currently locked

loadingScreen

loadingScreen: ILoadingScreen

Gets or sets the current loading screen object

See

https://doc.babylonjs.com/features/featuresDeepDive/scene/customLoadingScreen

loadingUIBackgroundColor

loadingUIBackgroundColor: string

Sets the current loading screen background color

See

https://doc.babylonjs.com/features/featuresDeepDive/scene/customLoadingScreen

loadingUIText

loadingUIText: string

Sets the current loading screen text

See

https://doc.babylonjs.com/features/featuresDeepDive/scene/customLoadingScreen

onAfterShaderCompilationObservable

onAfterShaderCompilationObservable: Observable<AbstractEngine>

Observable raised when the engine has just compiled a shader

`Readonly`onAfterViewRenderObservable

onAfterViewRenderObservable: Observable<EngineView>

Will be triggered after the view rendered

onBeforeShaderCompilationObservable

onBeforeShaderCompilationObservable: Observable<AbstractEngine>

Observable raised when the engine is about to compile a shader

onBeforeTextureInitObservable

onBeforeTextureInitObservable: Observable<Texture>

Observable event triggered before each texture is initialized

`Readonly`onBeforeViewRenderObservable

onBeforeViewRenderObservable: Observable<EngineView>

Will be triggered before the view renders

onBeginFrameObservable

onBeginFrameObservable: Observable<AbstractEngine>

Observable raised when the engine begins a new frame

onCanvasBlurObservable

onCanvasBlurObservable: Observable<AbstractEngine>

Observable event triggered each time the canvas loses focus

onCanvasFocusObservable

onCanvasFocusObservable: Observable<AbstractEngine>

Observable event triggered each time the canvas gains focus

onCanvasPointerOutObservable

onCanvasPointerOutObservable: Observable<PointerEvent>

Observable event triggered each time the canvas receives pointerout event

onContextLostObservable

onContextLostObservable: Observable<AbstractEngine>

Observable signaled when a context lost event is raised

onContextRestoredObservable

onContextRestoredObservable: Observable<AbstractEngine>

Observable signaled when a context restored event is raised

`Readonly`onDisposeObservable

onDisposeObservable: Observable<AbstractEngine>

An event triggered when the engine is disposed.

onEffectErrorObservable

onEffectErrorObservable: Observable<{ effect: Effect; errors: string }>

Observable event triggered each time an effect compilation fails

onEndFrameObservable

onEndFrameObservable: Observable<AbstractEngine>

Observable raised when the engine ends the current frame

onNewSceneAddedObservable

onNewSceneAddedObservable: Observable<Scene>

Event raised when a new scene is created

`Readonly`onReleaseEffectsObservable

onReleaseEffectsObservable: Observable<AbstractEngine>

An event triggered when a global cleanup of all effects is required

onResizeObservable

onResizeObservable: Observable<AbstractEngine>

Observable event triggered each time the rendering canvas is resized

postProcesses

postProcesses: PostProcess[]

Gets the list of created postprocesses

premultipliedAlpha

premultipliedAlpha: boolean

Defines whether the engine has been created with the premultipliedAlpha option on or not.

preventCacheWipeBetweenFrames

preventCacheWipeBetweenFrames: boolean

Gets or sets a boolean indicating that cache can be kept between frames

renderEvenInBackground

renderEvenInBackground: boolean

Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foreground

scenes

scenes: Scene[]

Gets the list of created scenes

skipFrameRender

skipFrameRender: boolean

Skip frame rendering but keep the frame heartbeat (begin/end frame). This is useful if you need all the plumbing but not the rendering work. (for instance when capturing a screenshot where you do not want to mix rendering to the screen and to the screenshot)

`Readonly`startTime

startTime: number

The time (in milliseconds elapsed since the current page has been loaded) when the engine was initialized

`Readonly`useExactSrgbConversions

useExactSrgbConversions: boolean

Gets a boolean indicating if the exact sRGB conversions or faster approximations are used for converting to and from linear space.

validateShaderPrograms

validateShaderPrograms: boolean

Gets or sets a boolean indicating if the engine should validate programs after compilation

views

views: EngineView[]

Gets or sets the list of views

`Static`_RescalePostProcessFactory

_RescalePostProcessFactory: Nullable<(engine: AbstractEngine) => PostProcess>

Method called to create the default rescale post process on each engine.

`Static`audioEngine

audioEngine: Nullable<IAudioEngine>

Gets the audio engine

See

https://doc.babylonjs.com/features/featuresDeepDive/audio/playingSoundsMusic

Deprecated

please use AudioEngineV2 instead

`Static`AudioEngineFactory

AudioEngineFactory: (
    hostElement: Nullable<HTMLElement>,
    audioContext: Nullable<AudioContext>,
    audioDestination: Nullable<
        AudioDestinationNode
        | MediaStreamAudioDestinationNode,
    >,
) => IAudioEngine

Default AudioEngine factory responsible of creating the Audio Engine. By default, this will create a BabylonJS Audio Engine if the workload has been embedded.

Deprecated

please use AudioEngineV2 instead

`Static`CollisionsEpsilon

CollisionsEpsilon: number

Gets or sets the epsilon value used by collision engine

`Static`ExceptionList

ExceptionList: (
    | {
        capture: string;
        captureConstraint: number;
        key: string;
        targets: string[];
    }
    | {
        capture: null;
        captureConstraint: null;
        key: string;
        targets: string[];
    }
)[]

Use this array to turn off some WebGL2 features on known buggy browsers version

`Static`OfflineProviderFactory

OfflineProviderFactory: (
    urlToScene: string,
    callbackManifestChecked: (checked: boolean) => any,
    disableManifestCheck: boolean,
) => IOfflineProvider

Default offline support factory responsible of creating a tool used to store data locally. By default, this will create a Database object if the workload has been embedded.

`Static`QueueNewFrame

QueueNewFrame: (func: () => void, requester?: any) => number

Queue a new function into the requested animation frame pool (ie. this function will be executed by the browser (or the javascript engine) for the next frame)

Type declaration

- (func: () => void, requester?: any): number
- Parameters
  - func: () => void
    the function to be called
  - Optionalrequester: any
    the object that will request the next frame. Falls back to window.
  Returns number
  frame number

Accessors

activeRenderLoops

get activeRenderLoops(): readonly () => void[]
Gets the list of current active render loop functions

Returns readonly () => void[]
a read only array with the current render loop functions
Inherited from AbstractEngine.activeRenderLoops
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116387

alphaState

get alphaState(): AlphaState
Gets the alpha state manager

Returns AlphaState
Inherited from AbstractEngine.alphaState
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116286

compatibilityMode

get compatibilityMode(): boolean
(WebGPU only) True (default) to be in compatibility mode, meaning rendering all existing scenes without artifacts (same rendering than WebGL). Setting the property to false will improve performances but may not work in some scenes if some precautions are not taken. See https://doc.babylonjs.com/setup/support/webGPU/webGPUOptimization/webGPUNonCompatibilityMode for more details

Returns boolean
Inherited from AbstractEngine.compatibilityMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116482
set compatibilityMode(mode: boolean): void
Parameters
- mode: boolean
Returns void
Inherited from AbstractEngine.compatibilityMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116483

currentViewport

get currentViewport(): Nullable<IViewportLike>
Gets the current viewport

Returns Nullable<IViewportLike>
Inherited from AbstractEngine.currentViewport
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116714

depthCullingState

get depthCullingState(): DepthCullingState
Gets the depth culling state manager

Returns DepthCullingState
Inherited from AbstractEngine.depthCullingState
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116282

description

get description(): string
Returns a string describing the current engine

Returns string
Inherited from AbstractEngine.description
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116761

doNotHandleContextLost

get doNotHandleContextLost(): boolean
Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events

Returns boolean
See
https://doc.babylonjs.com/features/featuresDeepDive/scene/optimize_your_scene#handling-webgl-context-lost
Inherited from AbstractEngine.doNotHandleContextLost
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116921
set doNotHandleContextLost(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AbstractEngine.doNotHandleContextLost
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116922

emptyCubeTexture

get emptyCubeTexture(): InternalTexture
Gets the default empty cube texture

Returns InternalTexture
Inherited from AbstractEngine.emptyCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116378

emptyTexture

get emptyTexture(): InternalTexture
Gets the default empty texture

Returns InternalTexture
Inherited from AbstractEngine.emptyTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116366

emptyTexture2DArray

get emptyTexture2DArray(): InternalTexture
Gets the default empty 2D array texture

Returns InternalTexture
Inherited from AbstractEngine.emptyTexture2DArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116374

emptyTexture3D

get emptyTexture3D(): InternalTexture
Gets the default empty 3D texture

Returns InternalTexture
Inherited from AbstractEngine.emptyTexture3D
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116370

framebufferDimensionsObject

set framebufferDimensionsObject(
    dimensions: Nullable<
        { framebufferHeight: number; framebufferWidth: number },
    >,
): void
sets the object from which width and height will be taken from when getting render width and height Will fallback to the gl object
Parameters
- dimensions: Nullable<{ framebufferHeight: number; framebufferWidth: number }>
  the framebuffer width and height that will be used.
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111902

frameId

get frameId(): number
Gets the current frame id

Returns number
Inherited from AbstractEngine.frameId
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116162

isDisposed

get isDisposed(): boolean
Gets a boolean indicating if the engine was disposed

Returns boolean
Inherited from AbstractEngine.isDisposed
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116326

isStencilEnable

get isStencilEnable(): boolean
Returns true if the stencil buffer has been enabled through the creation option of the context.

Returns boolean
Inherited from AbstractEngine.isStencilEnable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116928

isWebGPU

get isWebGPU(): boolean
Gets a boolean indicating if the engine runs in WebGPU or not.

Returns boolean
Inherited from AbstractEngine.isWebGPU
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116166

maxFPS

get maxFPS(): undefined | number
Gets or sets max frame per second allowed. Will return undefined if not capped

Returns undefined | number
Inherited from AbstractEngine.maxFPS
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116422
set maxFPS(value: undefined | number): void
Parameters
- value: undefined | number
Returns void
Inherited from AbstractEngine.maxFPS
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116423

name

get name(): string
Gets or sets the name of the engine

Returns string
Overrides AbstractEngine.name
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111823
set name(value: string): void
Gets or sets the name of the engine
Parameters
- value: string
Returns void
Overrides AbstractEngine.name
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111824

needPOTTextures

get needPOTTextures(): boolean
Gets a boolean indicating that only power of 2 textures are supported Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them

Returns boolean
Overrides AbstractEngine.needPOTTextures
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111863

performanceMonitor

get performanceMonitor(): PerformanceMonitor
Gets the performance monitor attached to this engine

Returns PerformanceMonitor
See
https://doc.babylonjs.com/features/featuresDeepDive/scene/optimize_your_scene#engineinstrumentation
Overrides AbstractEngine.performanceMonitor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111994

shaderPlatformName

get shaderPlatformName(): string
Gets the shader platform name used by the effects.

Returns string
Inherited from AbstractEngine.shaderPlatformName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116215

snapshotRendering

get snapshotRendering(): boolean
Enables or disables the snapshot rendering mode Note that the WebGL engine does not support snapshot rendering so setting the value won't have any effect for this engine

Returns boolean
Inherited from AbstractEngine.snapshotRendering
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116339
set snapshotRendering(activate: boolean): void
Parameters
- activate: boolean
Returns void
Inherited from AbstractEngine.snapshotRendering
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116340

snapshotRenderingMode

get snapshotRenderingMode(): number
Gets or sets the snapshot rendering mode

Returns number
Inherited from AbstractEngine.snapshotRenderingMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116344
set snapshotRenderingMode(mode: number): void
Parameters
- mode: number
Returns void
Inherited from AbstractEngine.snapshotRenderingMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116345

stencilState

get stencilState(): StencilState
Gets the stencil state manager

Returns StencilState
Inherited from AbstractEngine.stencilState
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116290

stencilStateComposer

get stencilStateComposer(): StencilStateComposer
Gets the stencil state composer

Returns StencilStateComposer
Inherited from AbstractEngine.stencilStateComposer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116294

supportsUniformBuffers

get supportsUniformBuffers(): boolean
Gets a boolean indicating that the engine supports uniform buffers

Returns boolean
See
https://doc.babylonjs.com/setup/support/webGL2#uniform-buffer-objets
Overrides AbstractEngine.supportsUniformBuffers
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111848

useReverseDepthBuffer

get useReverseDepthBuffer(): boolean
Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near. This can provide greater z depth for distant objects.

Returns boolean
Inherited from AbstractEngine.useReverseDepthBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116267
set useReverseDepthBuffer(useReverse: boolean): void
Parameters
- useReverse: boolean
Returns void
Inherited from AbstractEngine.useReverseDepthBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116268

version

get version(): number
Returns the version of the engine

Returns number
Overrides AbstractEngine.version
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111828

webGLVersion

get webGLVersion(): number
Gets version of the current webGL context Keep it for back compat - use version instead

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

`Static`HasMajorPerformanceCaveat

get HasMajorPerformanceCaveat(): boolean
Gets a boolean indicating if the engine can be instantiated on a performant device (ie. if a webGL context can be found and it does not use a slow implementation)

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

`Static`IsSupported

get IsSupported(): boolean
Gets a boolean indicating if the engine can be instantiated (ie. if a webGL context can be found)

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

`Static`IsSupportedAsync

get IsSupportedAsync(): Promise<boolean>

Gets a Promise indicating if the engine can be instantiated (ie. if a webGL context can be found)

Returns Promise<boolean>

`Static`NpmPackage

get NpmPackage(): string
Returns the current npm package of the sdk

Returns string
Inherited from AbstractEngine.NpmPackage
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116859

`Static`ShadersRepository

get ShadersRepository(): string
Gets or sets the relative url used to load shaders if using the engine in non-minified mode

Returns string
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111832
set ShadersRepository(value: string): void
Parameters
- value: string
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111833

`Static`Version

get Version(): string
Returns the current version of the framework

Returns string
Inherited from AbstractEngine.Version
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116863

Methods

_createDepthStencilCubeTexture

_createDepthStencilCubeTexture(
size: number,
options: DepthTextureCreationOptions,
): InternalTexture
Creates a depth stencil cube texture. This is only available in WebGL 2.
Parameters
- size: number
  The size of face edge in the cube texture.
- options: DepthTextureCreationOptions
  The options defining the cube texture.
Returns InternalTexture
The cube texture
Inherited from AbstractEngine._createDepthStencilCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120185
_createDepthStencilCubeTexture(
size: number,
options: DepthTextureCreationOptions,
): InternalTexture
Creates a depth stencil cube texture. This is only available in WebGL 2.
Parameters
- size: number
  The size of face edge in the cube texture.
- options: DepthTextureCreationOptions
  The options defining the cube texture.
Returns InternalTexture
The cube texture
Inherited from AbstractEngine._createDepthStencilCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122322

_createImageBitmapFromSource

_createImageBitmapFromSource(
imageSource: string,
options?: ImageBitmapOptions,
): Promise<ImageBitmap>
Engine abstraction for loading and creating an image bitmap from a given source string.
Parameters
- imageSource: string
  source to load the image from.
- Optionaloptions: ImageBitmapOptions
  An object that sets options for the image's extraction.
Returns Promise<ImageBitmap>
Inherited from AbstractEngine._createImageBitmapFromSource
- Defined in .temp/typedoc/docdirectory/doc.d.ts:117162

_getInternalFormatFromDepthTextureFormat

_getInternalFormatFromDepthTextureFormat(
    textureFormat: number,
    hasDepth: boolean,
    hasStencil: boolean,
): number
Parameters
- textureFormat: number
- hasDepth: boolean
- hasStencil: boolean
Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112688

_getWebGLTextureTypeFromDepthTextureFormat

_getWebGLTextureTypeFromDepthTextureFormat(textureFormat: number): number
Parameters
- textureFormat: number
Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112689

_updateRenderBuffer

_updateRenderBuffer(
    renderBuffer: Nullable<WebGLRenderbuffer>,
    width: number,
    height: number,
    samples: number,
    internalFormat: number,
    msInternalFormat: number,
    attachment: number,
    unbindBuffer?: boolean,
): Nullable<WebGLRenderbuffer>
Parameters
- renderBuffer: Nullable<WebGLRenderbuffer>
- width: number
- height: number
- samples: number
- internalFormat: number
- msInternalFormat: number
- attachment: number
- OptionalunbindBuffer: boolean
Returns Nullable<WebGLRenderbuffer>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112698

applyStates

applyStates(): void
Apply all cached states (depth, culling, stencil and alpha)

Returns void
Overrides AbstractEngine.applyStates
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112551

areAllComputeEffectsReady

areAllComputeEffectsReady(): boolean
Gets a boolean indicating if all created compute effects are ready

Returns boolean
true if all effects are ready
Inherited from AbstractEngine.areAllComputeEffectsReady
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122492

areAllEffectsReady

areAllEffectsReady(): boolean
Gets a boolean indicating if all created effects are ready

Returns boolean
true if all effects are ready
Overrides AbstractEngine.areAllEffectsReady
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111927

attachContextLostEvent

attachContextLostEvent(callback: (event: WebGLContextEvent) => void): void
Attach a new callback raised when context lost event is fired
Parameters
- callback: (event: WebGLContextEvent) => void
  defines the callback to call
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112770

attachContextRestoredEvent

attachContextRestoredEvent(callback: (event: WebGLContextEvent) => void): void
Attach a new callback raised when context restored event is fired
Parameters
- callback: (event: WebGLContextEvent) => void
  defines the callback to call
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112775

beginFrame

beginFrame(): void
Begin a new frame

Returns void
Inherited from AbstractEngine.beginFrame
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116399

beginOcclusionQuery

beginOcclusionQuery(algorithmType: number, query: OcclusionQuery): boolean
Initiates an occlusion query
Parameters
- algorithmType: number
  defines the algorithm to use
- query: OcclusionQuery
  defines the query to use
Returns boolean
the current engine

See
https://doc.babylonjs.com/features/featuresDeepDive/occlusionQueries
Inherited from AbstractEngine.beginOcclusionQuery
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122858

bindArrayBuffer

bindArrayBuffer(buffer: Nullable<DataBuffer>): void
Bind a webGL buffer to the webGL context
Parameters
- buffer: Nullable<DataBuffer>
  defines the buffer to bind
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112087

bindAttachments

bindAttachments(attachments: number[]): void
Select a subsets of attachments to draw to.
Parameters
- attachments: number[]
  gl attachments
Returns void
Inherited from AbstractEngine.bindAttachments
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120127
bindAttachments(attachments: number[]): void
Select a subsets of attachments to draw to.
Parameters
- attachments: number[]
  gl attachments
Returns void
Inherited from AbstractEngine.bindAttachments
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122235

bindBuffers

bindBuffers(
    vertexBuffers: { [key: string]: Nullable<VertexBuffer> },
    indexBuffer: Nullable<DataBuffer>,
    effect: Effect,
    overrideVertexBuffers?: { [kind: string]: Nullable<VertexBuffer> },
): void
Bind a list of vertex buffers to the webGL context
Parameters
- vertexBuffers: { [key: string]: Nullable<VertexBuffer> }
  defines the list of vertex buffers to bind
- indexBuffer: Nullable<DataBuffer>
  defines the index buffer to bind
- effect: Effect
  defines the effect associated with the vertex buffers
- OptionaloverrideVertexBuffers: { [kind: string]: Nullable<VertexBuffer> }
  defines optional list of avertex buffers that overrides the entries in vertexBuffers
Returns void
Overrides AbstractEngine.bindBuffers
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112139

bindBuffersDirectly

bindBuffersDirectly(
    vertexBuffer: DataBuffer,
    indexBuffer: DataBuffer,
    vertexDeclaration: number[],
    vertexStrideSize: number,
    effect: Effect,
): void
Bind webGl buffers directly to the webGL context
Parameters
- vertexBuffer: DataBuffer
  defines the vertex buffer to bind
- indexBuffer: DataBuffer
  defines the index buffer to bind
- vertexDeclaration: number[]
  defines the vertex declaration to use with the vertex buffer
- vertexStrideSize: number
  defines the vertex stride of the vertex buffer
- effect: Effect
  defines the effect associated with the vertex buffer
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112130

bindFramebuffer

bindFramebuffer(
    rtWrapper: RenderTargetWrapper,
    faceIndex?: number,
    requiredWidth?: number,
    requiredHeight?: number,
    forceFullscreenViewport?: boolean,
    lodLevel?: number,
    layer?: number,
): void
Binds the frame buffer to the specified texture.
Parameters
- rtWrapper: RenderTargetWrapper
  The render target wrapper to render to
- OptionalfaceIndex: number
  The face of the texture to render to in case of cube texture and if the render target wrapper is not a multi render target
- OptionalrequiredWidth: number
  The width of the target to render to
- OptionalrequiredHeight: number
  The height of the target to render to
- OptionalforceFullscreenViewport: boolean
  Forces the viewport to be the entire texture/screen if true
- OptionallodLevel: number
  Defines the lod level to bind to the frame buffer
- Optionallayer: number
  Defines the 2d array index to bind to the frame buffer if the render target wrapper is not a multi render target
Returns void
Overrides AbstractEngine.bindFramebuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112005

bindInstancesBuffer

bindInstancesBuffer(
    instancesBuffer: DataBuffer,
    attributesInfo: InstancingAttributeInfo[],
    computeStride?: boolean,
): void
Bind the content of a webGL buffer used with instantiation
Parameters
- instancesBuffer: DataBuffer
  defines the webGL buffer to bind
- attributesInfo: InstancingAttributeInfo[]
  defines the offsets or attributes information used to determine where data must be stored in the buffer
- OptionalcomputeStride: boolean
  defines Whether to compute the strides from the info or use the default 0
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112171

bindSamplers

bindSamplers(effect: Effect): void
Binds an effect to the webGL context
Parameters
- effect: Effect
  defines the effect to bind
Returns void
Overrides AbstractEngine.bindSamplers
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112715

bindUniformBlock

bindUniformBlock(
    pipelineContext: IPipelineContext,
    blockName: string,
    index: number,
): void
Bind a specific block at a given index in a specific shader program
Parameters
- pipelineContext: IPipelineContext
  defines the pipeline context to use
- blockName: string
  defines the block name
- index: number
  defines the index where to bind the block
Returns void
Inherited from AbstractEngine.bindUniformBlock
- Defined in .temp/typedoc/docdirectory/doc.d.ts:121803

bindUniformBuffer

bindUniformBuffer(buffer: Nullable<DataBuffer>): void
Bind an uniform buffer to the current webGL context
Parameters
- buffer: Nullable<DataBuffer>
  defines the buffer to bind
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:121789

bindUniformBufferBase

bindUniformBufferBase(buffer: DataBuffer, location: number, name: string): void
Bind a buffer to the current webGL context at a given location
Parameters
- buffer: DataBuffer
  defines the buffer to bind
- location: number
  defines the index where to bind the buffer
- name: string
  Name of the uniform variable to bind
Returns void
Inherited from AbstractEngine.bindUniformBufferBase
- Defined in .temp/typedoc/docdirectory/doc.d.ts:121796

bindVertexArrayObject

bindVertexArrayObject(
vertexArrayObject: WebGLVertexArrayObject,
indexBuffer: Nullable<DataBuffer>,
): void
Bind a specific vertex array object
Parameters
- vertexArrayObject: WebGLVertexArrayObject
  defines the vertex array object to bind
- indexBuffer: Nullable<DataBuffer>
  defines the index buffer to bind
Returns void
See
https://doc.babylonjs.com/setup/support/webGL2#vertex-array-objects
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112121

buildTextureLayout

buildTextureLayout(textureStatus: boolean[]): number[]
Creates a layout object to draw/clear on specific textures in a MRT
Parameters
- textureStatus: boolean[]
  textureStatus[i] indicates if the i-th is active
Returns number[]
A layout to be fed to the engine, calling bindAttachments.
Inherited from AbstractEngine.buildTextureLayout
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120133
buildTextureLayout(textureStatus: boolean[]): number[]
Creates a layout object to draw/clear on specific textures in a MRT
Parameters
- textureStatus: boolean[]
  textureStatus[i] indicates if the i-th is active
Returns number[]
A layout to be fed to the engine, calling bindAttachments.
Inherited from AbstractEngine.buildTextureLayout
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122241

cacheStencilState

cacheStencilState(): void
Caches the state of the stencil buffer

Returns void
Inherited from AbstractEngine.cacheStencilState
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122757

captureGPUFrameTime

captureGPUFrameTime(value: boolean): void
Enable or disable the GPU frame time capture
Parameters
- value: boolean
  True to enable, false to disable
Returns void
Inherited from AbstractEngine.captureGPUFrameTime
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122606

clear

clear(
    color: Nullable<IColor4Like>,
    backBuffer: boolean,
    depth: boolean,
    stencil?: boolean,
): void
Clear the current render buffer or the current render target (if any is set up)
Parameters
- color: Nullable<IColor4Like>
  defines the color to use
- backBuffer: boolean
  defines if the back buffer must be cleared
- depth: boolean
  defines if the depth buffer must be cleared
- Optionalstencil: boolean
  defines if the stencil buffer must be cleared
Returns void
Overrides AbstractEngine.clear
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111981

clearInternalTexturesCache

clearInternalTexturesCache(): void
Clears the list of texture accessible through engine. This can help preventing texture load conflict due to name collision.

Returns void
Inherited from AbstractEngine.clearInternalTexturesCache
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116835

computeDispatch

computeDispatch(
    effect: ComputeEffect,
    context: IComputeContext,
    bindings: ComputeBindingList,
    x: number,
    y?: number,
    z?: number,
    bindingsMapping?: ComputeBindingMapping,
    gpuPerfCounter?: WebGPUPerfCounter,
): void
Dispatches a compute shader
Parameters
- effect: ComputeEffect
  The compute effect
- context: IComputeContext
  The compute context
- bindings: ComputeBindingList
  The list of resources to bind to the shader
- x: number
  The number of workgroups to execute on the X dimension
- Optionaly: number
  The number of workgroups to execute on the Y dimension
- Optionalz: number
  The number of workgroups to execute on the Z dimension
- OptionalbindingsMapping: ComputeBindingMapping
  list of bindings mapping (key is property name, value is binding location)
- OptionalgpuPerfCounter: WebGPUPerfCounter
  GPU time computed for the compute shader will be assigned to this object
Returns void
Inherited from AbstractEngine.computeDispatch
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122475

computeDispatchIndirect

computeDispatchIndirect(
    effect: ComputeEffect,
    context: IComputeContext,
    bindings: ComputeBindingList,
    buffer: DataBuffer,
    offset?: number,
    bindingsMapping?: ComputeBindingMapping,
    gpuPerfCounter?: WebGPUPerfCounter,
): void
Dispatches a compute shader
Parameters
- effect: ComputeEffect
  The compute effect
- context: IComputeContext
  The compute context
- bindings: ComputeBindingList
  The list of resources to bind to the shader
- buffer: DataBuffer
- Optionaloffset: number
- OptionalbindingsMapping: ComputeBindingMapping
  list of bindings mapping (key is property name, value is binding location)
- OptionalgpuPerfCounter: WebGPUPerfCounter
  GPU time computed for the compute shader will be assigned to this object
Returns void
Inherited from AbstractEngine.computeDispatchIndirect
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122487

createCanvas

createCanvas(width: number, height: number): ICanvas
Create a canvas. This method is overridden by other engines
Parameters
- width: number
  width
- height: number
  height
Returns ICanvas
ICanvas interface
Inherited from AbstractEngine.createCanvas
- Defined in .temp/typedoc/docdirectory/doc.d.ts:117198

createCanvasImage

createCanvasImage(): BABYLON.IImage
Create an image to use with canvas

Returns BABYLON.IImage
IImage interface
Inherited from AbstractEngine.createCanvasImage
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116751

createCanvasPath2D

createCanvasPath2D(d?: string): IPath2D
Create a 2D path to use with canvas
Parameters
- Optionald: string
  SVG path string
Returns IPath2D
IPath2D interface
Inherited from AbstractEngine.createCanvasPath2D
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116757

createComputeContext

createComputeContext(): undefined | IComputeContext
Creates a new compute context

Returns undefined | IComputeContext
the new context
Inherited from AbstractEngine.createComputeContext
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122463

createComputeEffect

createComputeEffect(
baseName: string | IComputeShaderPath & {},
options: IComputeEffectCreationOptions,
): ComputeEffect
Creates a new compute effect
Parameters
- baseName: string | IComputeShaderPath & {}
  Name of the effect
- options: IComputeEffectCreationOptions
  Options used to create the effect
Returns ComputeEffect
The new compute effect
Inherited from AbstractEngine.createComputeEffect
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122448

createComputePipelineContext

createComputePipelineContext(): IComputePipelineContext
Creates a new compute pipeline context

Returns IComputePipelineContext
the new pipeline
Inherited from AbstractEngine.createComputePipelineContext
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122458

createCubeTexture

createCubeTexture(
    rootUrl: string,
    scene: Nullable<Scene>,
    files: Nullable<string[]>,
    noMipmap: undefined | boolean,
    onLoad: Nullable<(data?: any) => void>,
    onError: Nullable<(message?: string, exception?: any) => void>,
    format: undefined | number,
    forcedExtension: any,
    createPolynomials: boolean,
    lodScale: number,
    lodOffset: number,
    fallback: Nullable<InternalTexture>,
    loaderOptions: any,
    useSRGBBuffer: boolean,
    buffer: Nullable<ArrayBufferView>,
): InternalTexture
Creates a cube texture
Parameters
- rootUrl: string
  defines the url where the files to load is located
- scene: Nullable<Scene>
  defines the current scene
- files: Nullable<string[]>
  defines the list of files to load (1 per face)
- noMipmap: undefined | boolean
  defines a boolean indicating that no mipmaps shall be generated (false by default)
- onLoad: Nullable<(data?: any) => void>
  defines an optional callback raised when the texture is loaded
- onError: Nullable<(message?: string, exception?: any) => void>
  defines an optional callback raised if there is an issue to load the texture
- format: undefined | number
  defines the format of the data
- forcedExtension: any
  defines the extension to use to pick the right loader
- createPolynomials: boolean
  if a polynomial sphere should be created for the cube texture
- lodScale: number
  defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
- lodOffset: number
  defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
- fallback: Nullable<InternalTexture>
  defines texture to use while falling back when (compressed) texture file not found.
- loaderOptions: any
  options to be passed to the loader
- useSRGBBuffer: boolean
  defines if the texture must be loaded in a sRGB GPU buffer (if supported by the GPU).
- buffer: Nullable<ArrayBufferView>
  defines the data buffer to load instead of loading the rootUrl
Returns InternalTexture
the cube texture as an InternalTexture
Inherited from AbstractEngine.createCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120205
createCubeTexture(
    rootUrl: string,
    scene: Nullable<Scene>,
    files: Nullable<string[]>,
    noMipmap: boolean,
    onLoad: Nullable<(data?: any) => void>,
    onError: Nullable<(message?: string, exception?: any) => void>,
    format: undefined | number,
    forcedExtension: any,
): InternalTexture
Creates a cube texture
Parameters
- rootUrl: string
  defines the url where the files to load is located
- scene: Nullable<Scene>
  defines the current scene
- files: Nullable<string[]>
  defines the list of files to load (1 per face)
- noMipmap: boolean
  defines a boolean indicating that no mipmaps shall be generated (false by default)
- onLoad: Nullable<(data?: any) => void>
  defines an optional callback raised when the texture is loaded
- onError: Nullable<(message?: string, exception?: any) => void>
  defines an optional callback raised if there is an issue to load the texture
- format: undefined | number
  defines the format of the data
- forcedExtension: any
  defines the extension to use to pick the right loader
Returns InternalTexture
the cube texture as an InternalTexture
Inherited from AbstractEngine.createCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120218
createCubeTexture(
    rootUrl: string,
    scene: Nullable<Scene>,
    files: Nullable<string[]>,
    noMipmap: boolean,
    onLoad: Nullable<(data?: any) => void>,
    onError: Nullable<(message?: string, exception?: any) => void>,
    format: undefined | number,
    forcedExtension: any,
    createPolynomials: boolean,
    lodScale: number,
    lodOffset: number,
): InternalTexture
Creates a cube texture
Parameters
- rootUrl: string
  defines the url where the files to load is located
- scene: Nullable<Scene>
  defines the current scene
- files: Nullable<string[]>
  defines the list of files to load (1 per face)
- noMipmap: boolean
  defines a boolean indicating that no mipmaps shall be generated (false by default)
- onLoad: Nullable<(data?: any) => void>
  defines an optional callback raised when the texture is loaded
- onError: Nullable<(message?: string, exception?: any) => void>
  defines an optional callback raised if there is an issue to load the texture
- format: undefined | number
  defines the format of the data
- forcedExtension: any
  defines the extension to use to pick the right loader
- createPolynomials: boolean
  if a polynomial sphere should be created for the cube texture
- lodScale: number
  defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
- lodOffset: number
  defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
Returns InternalTexture
the cube texture as an InternalTexture
Inherited from AbstractEngine.createCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120234
createCubeTexture(
    rootUrl: string,
    scene: Nullable<Scene>,
    files: Nullable<string[]>,
    noMipmap: undefined | boolean,
    onLoad: Nullable<(data?: any) => void>,
    onError: Nullable<(message?: string, exception?: any) => void>,
    format: undefined | number,
    forcedExtension: any,
    createPolynomials: boolean,
    lodScale: number,
    lodOffset: number,
    fallback: Nullable<InternalTexture>,
    loaderOptions: any,
    useSRGBBuffer: boolean,
    buffer: Nullable<ArrayBufferView>,
): InternalTexture
Creates a cube texture
Parameters
- rootUrl: string
  defines the url where the files to load is located
- scene: Nullable<Scene>
  defines the current scene
- files: Nullable<string[]>
  defines the list of files to load (1 per face)
- noMipmap: undefined | boolean
  defines a boolean indicating that no mipmaps shall be generated (false by default)
- onLoad: Nullable<(data?: any) => void>
  defines an optional callback raised when the texture is loaded
- onError: Nullable<(message?: string, exception?: any) => void>
  defines an optional callback raised if there is an issue to load the texture
- format: undefined | number
  defines the format of the data
- forcedExtension: any
  defines the extension to use to pick the right loader
- createPolynomials: boolean
  if a polynomial sphere should be created for the cube texture
- lodScale: number
  defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
- lodOffset: number
  defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
- fallback: Nullable<InternalTexture>
  defines texture to use while falling back when (compressed) texture file not found.
- loaderOptions: any
  options to be passed to the loader
- useSRGBBuffer: boolean
  defines if the texture must be loaded in a sRGB GPU buffer (if supported by the GPU).
- buffer: Nullable<ArrayBufferView>
  defines the data buffer to load instead of loading the rootUrl
Returns InternalTexture
the cube texture as an InternalTexture
Inherited from AbstractEngine.createCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122342
createCubeTexture(
    rootUrl: string,
    scene: Nullable<Scene>,
    files: Nullable<string[]>,
    noMipmap: boolean,
    onLoad: Nullable<(data?: any) => void>,
    onError: Nullable<(message?: string, exception?: any) => void>,
    format: undefined | number,
    forcedExtension: any,
): InternalTexture
Creates a cube texture
Parameters
- rootUrl: string
  defines the url where the files to load is located
- scene: Nullable<Scene>
  defines the current scene
- files: Nullable<string[]>
  defines the list of files to load (1 per face)
- noMipmap: boolean
  defines a boolean indicating that no mipmaps shall be generated (false by default)
- onLoad: Nullable<(data?: any) => void>
  defines an optional callback raised when the texture is loaded
- onError: Nullable<(message?: string, exception?: any) => void>
  defines an optional callback raised if there is an issue to load the texture
- format: undefined | number
  defines the format of the data
- forcedExtension: any
  defines the extension to use to pick the right loader
Returns InternalTexture
the cube texture as an InternalTexture
Inherited from AbstractEngine.createCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122355
createCubeTexture(
    rootUrl: string,
    scene: Nullable<Scene>,
    files: Nullable<string[]>,
    noMipmap: boolean,
    onLoad: Nullable<(data?: any) => void>,
    onError: Nullable<(message?: string, exception?: any) => void>,
    format: undefined | number,
    forcedExtension: any,
    createPolynomials: boolean,
    lodScale: number,
    lodOffset: number,
): InternalTexture
Creates a cube texture
Parameters
- rootUrl: string
  defines the url where the files to load is located
- scene: Nullable<Scene>
  defines the current scene
- files: Nullable<string[]>
  defines the list of files to load (1 per face)
- noMipmap: boolean
  defines a boolean indicating that no mipmaps shall be generated (false by default)
- onLoad: Nullable<(data?: any) => void>
  defines an optional callback raised when the texture is loaded
- onError: Nullable<(message?: string, exception?: any) => void>
  defines an optional callback raised if there is an issue to load the texture
- format: undefined | number
  defines the format of the data
- forcedExtension: any
  defines the extension to use to pick the right loader
- createPolynomials: boolean
  if a polynomial sphere should be created for the cube texture
- lodScale: number
  defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
- lodOffset: number
  defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
Returns InternalTexture
the cube texture as an InternalTexture
Inherited from AbstractEngine.createCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122371

createDepthStencilTexture

createDepthStencilTexture(
    size: TextureSize,
    options: DepthTextureCreationOptions,
    rtWrapper: RenderTargetWrapper,
): InternalTexture
Creates a depth stencil texture. This is only available in WebGL 2 or with the depth texture extension available.
Parameters
- size: TextureSize
  The size of face edge in the texture.
- options: DepthTextureCreationOptions
  The options defining the texture.
- rtWrapper: RenderTargetWrapper
  The render target wrapper for which the depth/stencil texture must be created
Returns InternalTexture
The texture
Inherited from AbstractEngine.createDepthStencilTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122619

createDrawContext

createDrawContext(): undefined | IDrawContext
Creates a new draw context

Returns undefined | IDrawContext
the new context
Overrides AbstractEngine.createDrawContext
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112307

createDynamicTexture

createDynamicTexture(
    width: number,
    height: number,
    generateMipMaps: boolean,
    samplingMode: number,
): InternalTexture
Creates a dynamic texture
Parameters
- width: number
  defines the width of the texture
- height: number
  defines the height of the texture
- generateMipMaps: boolean
  defines if the engine should generate the mip levels
- samplingMode: number
  defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
Returns InternalTexture
the dynamic texture inside an InternalTexture
Inherited from AbstractEngine.createDynamicTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120156
createDynamicTexture(
    width: number,
    height: number,
    generateMipMaps: boolean,
    samplingMode: number,
): InternalTexture
Creates a dynamic texture
Parameters
- width: number
  defines the width of the texture
- height: number
  defines the height of the texture
- generateMipMaps: boolean
  defines if the engine should generate the mip levels
- samplingMode: number
  defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
Returns InternalTexture
the dynamic texture inside an InternalTexture
Inherited from AbstractEngine.createDynamicTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122264

createDynamicUniformBuffer

createDynamicUniformBuffer(elements: FloatArray, label?: string): DataBuffer
Create a dynamic uniform buffer
Parameters
- elements: FloatArray
  defines the content of the uniform buffer
- Optionallabel: string
  defines a name for the buffer (for debugging purpose)
Returns DataBuffer
the webGL uniform buffer

See
https://doc.babylonjs.com/setup/support/webGL2#uniform-buffer-objets
Inherited from AbstractEngine.createDynamicUniformBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:121775

createDynamicVertexBuffer

createDynamicVertexBuffer(data: number | DataArray, _label?: string): DataBuffer
Creates a dynamic vertex buffer
Parameters
- data: number | DataArray
  the data for the dynamic vertex buffer
- Optional_label: string
  defines the label of the buffer (for debug purpose)
Returns DataBuffer
the new WebGL dynamic buffer
Overrides AbstractEngine.createDynamicVertexBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112072

createEffect

createEffect(
    baseName:
        | string
        | IShaderPath & { fragmentToken?: string; vertexToken?: string },
    attributesNamesOrOptions: string[] | IEffectCreationOptions,
    uniformsNamesOrEngine: string[] | ThinEngine,
    samplers?: string[],
    defines?: string,
    fallbacks?: IEffectFallbacks,
    onCompiled?: Nullable<(effect: Effect) => void>,
    onError?: Nullable<(effect: Effect, errors: string) => void>,
    indexParameters?: any,
    shaderLanguage?: ShaderLanguage,
    extraInitializationsAsync?: () => Promise<void>,
): Effect
Create a new effect (used to store vertex/fragment shaders)
Parameters
- baseName: string | IShaderPath & { fragmentToken?: string; vertexToken?: string }
  defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
- attributesNamesOrOptions: string[] | IEffectCreationOptions
  defines either a list of attribute names or an IEffectCreationOptions object
- uniformsNamesOrEngine: string[] | ThinEngine
  defines either a list of uniform names or the engine to use
- Optionalsamplers: string[]
  defines an array of string used to represent textures
- Optionaldefines: string
  defines the string containing the defines to use to compile the shaders
- Optionalfallbacks: IEffectFallbacks
  defines the list of potential fallbacks to use if shader compilation fails
- OptionalonCompiled: Nullable<(effect: Effect) => void>
  defines a function to call when the effect creation is successful
- OptionalonError: Nullable<(effect: Effect, errors: string) => void>
  defines a function to call when the effect creation has failed
- OptionalindexParameters: any
  defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
- OptionalshaderLanguage: ShaderLanguage
  the language the shader is written in (default: GLSL)
- OptionalextraInitializationsAsync: () => Promise<void>
  additional async code to run before preparing the effect
Returns Effect
the new Effect
Overrides AbstractEngine.createEffect
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112256

createEffectForParticles

createEffectForParticles(
    fragmentName: string,
    uniformsNames: string[],
    samplers: string[],
    defines: string,
    fallbacks?: EffectFallbacks,
    onCompiled?: (effect: Effect) => void,
    onError?: (effect: Effect, errors: string) => void,
    particleSystem?: IParticleSystem,
    shaderLanguage?: ShaderLanguage,
    vertexName?: string,
): Effect
Create an effect to use with particle systems. Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass the particle system for which you want to create a custom effect in the last parameter
Parameters
- fragmentName: string
  defines the base name of the effect (The name of file without .fragment.fx)
- uniformsNames: string[]
  defines a list of attribute names
- samplers: string[]
  defines an array of string used to represent textures
- defines: string
  defines the string containing the defines to use to compile the shaders
- Optionalfallbacks: EffectFallbacks
  defines the list of potential fallbacks to use if shader compilation fails
- OptionalonCompiled: (effect: Effect) => void
  defines a function to call when the effect creation is successful
- OptionalonError: (effect: Effect, errors: string) => void
  defines a function to call when the effect creation has failed
- OptionalparticleSystem: IParticleSystem
  the particle system you want to create the effect for
- OptionalshaderLanguage: ShaderLanguage
  defines the shader language to use
- OptionalvertexName: string
  defines the vertex base name of the effect (The name of file without .vertex.fx)
Returns Effect
the new Effect
Inherited from AbstractEngine.createEffectForParticles
- Defined in .temp/typedoc/docdirectory/doc.d.ts:33486

createImageBitmap

createImageBitmap(
image: ImageBitmapSource,
options?: ImageBitmapOptions,
): Promise<ImageBitmap>
Engine abstraction for createImageBitmap
Parameters
- image: ImageBitmapSource
  source for image
- Optionaloptions: ImageBitmapOptions
  An object that sets options for the image's extraction.
Returns Promise<ImageBitmap>
ImageBitmap
Inherited from AbstractEngine.createImageBitmap
- Defined in .temp/typedoc/docdirectory/doc.d.ts:117169

createIndexBuffer

createIndexBuffer(
    indices: IndicesArray,
    updatable?: boolean,
    _label?: string,
): DataBuffer
Creates a new index buffer
Parameters
- indices: IndicesArray
  defines the content of the index buffer
- Optionalupdatable: boolean
  defines if the index buffer must be updatable
- Optional_label: string
  defines the label of the buffer (for debug purpose)
Returns DataBuffer
a new webGL buffer
Overrides AbstractEngine.createIndexBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112081

createMaterialContext

createMaterialContext(): undefined | IMaterialContext
Creates a new material context

Returns undefined | IMaterialContext
the new context
Overrides AbstractEngine.createMaterialContext
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112302

createMultipleRenderTarget

createMultipleRenderTarget(
    size: TextureSize,
    options: IMultiRenderTargetOptions,
    initializeBuffers?: boolean,
): RenderTargetWrapper
Create a multi render target texture
Parameters
- size: TextureSize
  defines the size of the texture
- options: IMultiRenderTargetOptions
  defines the creation options
- OptionalinitializeBuffers: boolean
  if set to true, the engine will make an initializing call of drawBuffers
Returns RenderTargetWrapper
a new render target wrapper ready to render textures

See
https://doc.babylonjs.com/setup/support/webGL2#multiple-render-target
Inherited from AbstractEngine.createMultipleRenderTarget
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120102
createMultipleRenderTarget(
    size: TextureSize,
    options: IMultiRenderTargetOptions,
    initializeBuffers?: boolean,
): RenderTargetWrapper
Create a multi render target texture
Parameters
- size: TextureSize
  defines the size of the texture
- options: IMultiRenderTargetOptions
  defines the creation options
- OptionalinitializeBuffers: boolean
  if set to true, the engine will make an initializing call of drawBuffers
Returns RenderTargetWrapper
a new render target wrapper ready to render textures

See
https://doc.babylonjs.com/setup/support/webGL2#multiple-render-target
Inherited from AbstractEngine.createMultipleRenderTarget
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122210

createPipelineContext

createPipelineContext(
shaderProcessingContext: Nullable<_IShaderProcessingContext>,
): IPipelineContext
Creates a new pipeline context
Parameters
- shaderProcessingContext: Nullable<_IShaderProcessingContext>
  defines the shader processing context used during the processing if available
Returns IPipelineContext
the new pipeline
Overrides AbstractEngine.createPipelineContext
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112297

createPrefilteredCubeTexture

createPrefilteredCubeTexture(
    rootUrl: string,
    scene: Nullable<Scene>,
    lodScale: number,
    lodOffset: number,
    onLoad?: Nullable<(internalTexture: Nullable<InternalTexture>) => void>,
    onError?: Nullable<(message?: string, exception?: any) => void>,
    format?: number,
    forcedExtension?: any,
    createPolynomials?: boolean,
): InternalTexture
Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
Parameters
- rootUrl: string
  defines the url where the file to load is located
- scene: Nullable<Scene>
  defines the current scene
- lodScale: number
  defines scale to apply to the mip map selection
- lodOffset: number
  defines offset to apply to the mip map selection
- OptionalonLoad: Nullable<(internalTexture: Nullable<InternalTexture>) => void>
  defines an optional callback raised when the texture is loaded
- OptionalonError: Nullable<(message?: string, exception?: any) => void>
  defines an optional callback raised if there is an issue to load the texture
- Optionalformat: number
  defines the format of the data
- OptionalforcedExtension: any
  defines the extension to use to pick the right loader
- OptionalcreatePolynomials: boolean
  defines wheter or not to create polynomails harmonics for the texture
Returns InternalTexture
the cube texture as an InternalTexture
Inherited from AbstractEngine.createPrefilteredCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122132

createQuery

createQuery(): Nullable<OcclusionQuery>
Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)

Returns Nullable<OcclusionQuery>
the new query
Inherited from AbstractEngine.createQuery
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122833

createRawCubeTexture

createRawCubeTexture(
    data: Nullable<ArrayBufferView[]>,
    size: number,
    format: number,
    type: number,
    generateMipMaps: boolean,
    invertY: boolean,
    samplingMode: number,
    compression: Nullable<string>,
): InternalTexture
Creates a new raw cube texture
Parameters
- data: Nullable<ArrayBufferView[]>
  defines the array of data to use to create each face
- size: number
  defines the size of the textures
- format: number
  defines the format of the data
- type: number
  defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_BYTE)
- generateMipMaps: boolean
  defines if the engine should generate the mip levels
- invertY: boolean
  defines if data must be stored with Y axis inverted
- samplingMode: number
  defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
- compression: Nullable<string>
  defines the compression used (null by default)
Returns InternalTexture
the cube texture as an InternalTexture
Inherited from AbstractEngine.createRawCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:119981

createRawCubeTextureFromUrl

createRawCubeTextureFromUrl(
    url: string,
    scene: Nullable<Scene>,
    size: number,
    format: number,
    type: number,
    noMipmap: boolean,
    callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>,
    mipmapGenerator: Nullable<
        (faces: ArrayBufferView[]) => ArrayBufferView[][],
    >,
    onLoad: Nullable<() => void>,
    onError: Nullable<(message?: string, exception?: any) => void>,
): InternalTexture
Creates a new raw cube texture from a specified url
Parameters
- url: string
  defines the url where the data is located
- scene: Nullable<Scene>
  defines the current scene
- size: number
  defines the size of the textures
- format: number
  defines the format of the data
- type: number
  defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_BYTE)
- noMipmap: boolean
  defines if the engine should avoid generating the mip levels
- callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>
  defines a callback used to extract texture data from loaded data
- mipmapGenerator: Nullable<(faces: ArrayBufferView[]) => ArrayBufferView[][]>
  defines to provide an optional tool to generate mip levels
- onLoad: Nullable<() => void>
  defines a callback called when texture is loaded
- onError: Nullable<(message?: string, exception?: any) => void>
  defines a callback called if there is an error
Returns InternalTexture
the cube texture as an InternalTexture
Inherited from AbstractEngine.createRawCubeTextureFromUrl
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120026
createRawCubeTextureFromUrl(
    url: string,
    scene: Nullable<Scene>,
    size: number,
    format: number,
    type: number,
    noMipmap: boolean,
    callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>,
    mipmapGenerator: Nullable<
        (faces: ArrayBufferView[]) => ArrayBufferView[][],
    >,
    onLoad: Nullable<() => void>,
    onError: Nullable<(message?: string, exception?: any) => void>,
    samplingMode: number,
    invertY: boolean,
): InternalTexture
Creates a new raw cube texture from a specified url
Parameters
- url: string
  defines the url where the data is located
- scene: Nullable<Scene>
  defines the current scene
- size: number
  defines the size of the textures
- format: number
  defines the format of the data
- type: number
  defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_BYTE)
- noMipmap: boolean
  defines if the engine should avoid generating the mip levels
- callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>
  defines a callback used to extract texture data from loaded data
- mipmapGenerator: Nullable<(faces: ArrayBufferView[]) => ArrayBufferView[][]>
  defines to provide an optional tool to generate mip levels
- onLoad: Nullable<() => void>
  defines a callback called when texture is loaded
- onError: Nullable<(message?: string, exception?: any) => void>
  defines a callback called if there is an error
- samplingMode: number
  defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
- invertY: boolean
  defines if data must be stored with Y axis inverted
Returns InternalTexture
the cube texture as an InternalTexture
Inherited from AbstractEngine.createRawCubeTextureFromUrl
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120043
createRawCubeTextureFromUrl(
    url: string,
    scene: Nullable<Scene>,
    size: number,
    format: number,
    type: number,
    noMipmap: boolean,
    callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>,
    mipmapGenerator: Nullable<
        (faces: ArrayBufferView[]) => ArrayBufferView[][],
    >,
    onLoad: Nullable<() => void>,
    onError: Nullable<(message?: string, exception?: any) => void>,
): InternalTexture
Creates a new raw cube texture from a specified url
Parameters
- url: string
  defines the url where the data is located
- scene: Nullable<Scene>
  defines the current scene
- size: number
  defines the size of the textures
- format: number
  defines the format of the data
- type: number
  defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_BYTE)
- noMipmap: boolean
  defines if the engine should avoid generating the mip levels
- callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>
  defines a callback used to extract texture data from loaded data
- mipmapGenerator: Nullable<(faces: ArrayBufferView[]) => ArrayBufferView[][]>
  defines to provide an optional tool to generate mip levels
- onLoad: Nullable<() => void>
  defines a callback called when texture is loaded
- onError: Nullable<(message?: string, exception?: any) => void>
  defines a callback called if there is an error
Returns InternalTexture
the cube texture as an InternalTexture
Inherited from AbstractEngine.createRawCubeTextureFromUrl
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122023
createRawCubeTextureFromUrl(
    url: string,
    scene: Nullable<Scene>,
    size: number,
    format: number,
    type: number,
    noMipmap: boolean,
    callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>,
    mipmapGenerator: Nullable<
        (faces: ArrayBufferView[]) => ArrayBufferView[][],
    >,
    onLoad: Nullable<() => void>,
    onError: Nullable<(message?: string, exception?: any) => void>,
    samplingMode: number,
    invertY: boolean,
): InternalTexture
Creates a new raw cube texture from a specified url
Parameters
- url: string
  defines the url where the data is located
- scene: Nullable<Scene>
  defines the current scene
- size: number
  defines the size of the textures
- format: number
  defines the format of the data
- type: number
  defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_BYTE)
- noMipmap: boolean
  defines if the engine should avoid generating the mip levels
- callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>
  defines a callback used to extract texture data from loaded data
- mipmapGenerator: Nullable<(faces: ArrayBufferView[]) => ArrayBufferView[][]>
  defines to provide an optional tool to generate mip levels
- onLoad: Nullable<() => void>
  defines a callback called when texture is loaded
- onError: Nullable<(message?: string, exception?: any) => void>
  defines a callback called if there is an error
- samplingMode: number
  defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
- invertY: boolean
  defines if data must be stored with Y axis inverted
Returns InternalTexture
the cube texture as an InternalTexture
Inherited from AbstractEngine.createRawCubeTextureFromUrl
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122040

createRawShaderProgram

createRawShaderProgram(
    pipelineContext: IPipelineContext,
    vertexCode: string,
    fragmentCode: string,
    context?: WebGLRenderingContext,
    transformFeedbackVaryings?: Nullable<string[]>,
): WebGLProgram
Directly creates a webGL program
Parameters
- pipelineContext: IPipelineContext
  defines the pipeline context to attach to
- vertexCode: string
  defines the vertex shader code to use
- fragmentCode: string
  defines the fragment shader code to use
- Optionalcontext: WebGLRenderingContext
  defines the webGL context to use (if not set, the current one will be used)
- OptionaltransformFeedbackVaryings: Nullable<string[]>
  defines the list of transform feedback varyings to use
Returns WebGLProgram
the new webGL program
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112274

createRawTexture

createRawTexture(
    data: Nullable<ArrayBufferView>,
    width: number,
    height: number,
    format: number,
    generateMipMaps: boolean,
    invertY: boolean,
    samplingMode: number,
    compression?: Nullable<string>,
    type?: number,
    creationFlags?: number,
    useSRGBBuffer?: boolean,
): InternalTexture
Creates a raw texture
Parameters
- data: Nullable<ArrayBufferView>
  defines the data to store in the texture
- width: number
  defines the width of the texture
- height: number
  defines the height of the texture
- format: number
  defines the format of the data
- generateMipMaps: boolean
  defines if the engine should generate the mip levels
- invertY: boolean
  defines if data must be stored with Y axis inverted
- samplingMode: number
  defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
- Optionalcompression: Nullable<string>
  defines the compression used (null by default)
- Optionaltype: number
  defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_BYTE by default)
- OptionalcreationFlags: number
  specific flags to use when creating the texture (Constants.TEXTURE_CREATIONFLAG_STORAGE for storage textures, for eg)
- OptionaluseSRGBBuffer: boolean
  defines if the texture must be loaded in a sRGB GPU buffer (if supported by the GPU).
Returns InternalTexture
the raw texture inside an InternalTexture
Inherited from AbstractEngine.createRawTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:117047

createRawTexture2DArray

createRawTexture2DArray(
    data: Nullable<ArrayBufferView>,
    width: number,
    height: number,
    depth: number,
    format: number,
    generateMipMaps: boolean,
    invertY: boolean,
    samplingMode: number,
    compression?: Nullable<string>,
    textureType?: number,
    creationFlags?: number,
): InternalTexture
Creates a new raw 2D array texture
Parameters
- data: Nullable<ArrayBufferView>
  defines the data used to create the texture
- width: number
  defines the width of the texture
- height: number
  defines the height of the texture
- depth: number
  defines the number of layers of the texture
- format: number
  defines the format of the texture
- generateMipMaps: boolean
  defines if the engine must generate mip levels
- invertY: boolean
  defines if data must be stored with Y axis inverted
- samplingMode: number
  defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
- Optionalcompression: Nullable<string>
  defines the compressed used (can be null)
- OptionaltextureType: number
  defines the compressed used (can be null)
- OptionalcreationFlags: number
  specific flags to use when creating the texture (Constants.TEXTURE_CREATIONFLAG_STORAGE for storage textures, for eg)
Returns InternalTexture
a new raw 2D array texture (stored in an InternalTexture)
Inherited from AbstractEngine.createRawTexture2DArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:117079

createRawTexture3D

createRawTexture3D(
    data: Nullable<ArrayBufferView>,
    width: number,
    height: number,
    depth: number,
    format: number,
    generateMipMaps: boolean,
    invertY: boolean,
    samplingMode: number,
    compression?: Nullable<string>,
    textureType?: number,
    creationFlags?: number,
): InternalTexture
Creates a new raw 3D texture
Parameters
- data: Nullable<ArrayBufferView>
  defines the data used to create the texture
- width: number
  defines the width of the texture
- height: number
  defines the height of the texture
- depth: number
  defines the depth of the texture
- format: number
  defines the format of the texture
- generateMipMaps: boolean
  defines if the engine must generate mip levels
- invertY: boolean
  defines if data must be stored with Y axis inverted
- samplingMode: number
  defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
- Optionalcompression: Nullable<string>
  defines the compressed used (can be null)
- OptionaltextureType: number
  defines the compressed used (can be null)
- OptionalcreationFlags: number
  specific flags to use when creating the texture (Constants.TEXTURE_CREATIONFLAG_STORAGE for storage textures, for eg)
Returns InternalTexture
a new raw 3D texture (stored in an InternalTexture)
Inherited from AbstractEngine.createRawTexture3D
- Defined in .temp/typedoc/docdirectory/doc.d.ts:117063

createRenderPassId

createRenderPassId(name?: string): number
Creates a render pass id
Parameters
- Optionalname: string
  Name of the render pass (for debug purpose only)
Returns number
the id of the new render pass
Inherited from AbstractEngine.createRenderPassId
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122800

createRenderTargetCubeTexture

createRenderTargetCubeTexture(
size: number,
options?: RenderTargetCreationOptions,
): RenderTargetWrapper
Creates a new render target cube wrapper
Parameters
- size: number
  defines the size of the texture
- Optionaloptions: RenderTargetCreationOptions
  defines the options used to create the texture
Returns RenderTargetWrapper
a new render target cube wrapper
Inherited from AbstractEngine.createRenderTargetCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:119912
createRenderTargetCubeTexture(
size: number,
options?: RenderTargetCreationOptions,
): RenderTargetWrapper
Creates a new render target cube wrapper
Parameters
- size: number
  defines the size of the texture
- Optionaloptions: RenderTargetCreationOptions
  defines the options used to create the texture
Returns RenderTargetWrapper
a new render target cube wrapper
Inherited from AbstractEngine.createRenderTargetCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:121917

createRenderTargetTexture

createRenderTargetTexture(
size: TextureSize,
options: boolean | RenderTargetCreationOptions,
): RenderTargetWrapper
Creates a new render target texture
Parameters
- size: TextureSize
  defines the size of the texture
- options: boolean | RenderTargetCreationOptions
  defines the options used to create the texture
Returns RenderTargetWrapper
a new render target wrapper ready to render texture
Inherited from AbstractEngine.createRenderTargetTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:119923
createRenderTargetTexture(
size: TextureSize,
options: boolean | RenderTargetCreationOptions,
): RenderTargetWrapper
Creates a new render target texture
Parameters
- size: TextureSize
  defines the size of the texture
- options: boolean | RenderTargetCreationOptions
  defines the options used to create the texture
Returns RenderTargetWrapper
a new render target wrapper ready to render texture
Inherited from AbstractEngine.createRenderTargetTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:121933

createShaderProgram

createShaderProgram(
    pipelineContext: IPipelineContext,
    vertexCode: string,
    fragmentCode: string,
    defines: Nullable<string>,
    context?: WebGLRenderingContext,
    transformFeedbackVaryings?: Nullable<string[]>,
): WebGLProgram
Creates a webGL program
Parameters
- pipelineContext: IPipelineContext
  defines the pipeline context to attach to
- vertexCode: string
  defines the vertex shader code to use
- fragmentCode: string
  defines the fragment shader code to use
- defines: Nullable<string>
  defines the string containing the defines to use to compile the shaders
- Optionalcontext: WebGLRenderingContext
  defines the webGL context to use (if not set, the current one will be used)
- OptionaltransformFeedbackVaryings: Nullable<string[]>
  defines the list of transform feedback varyings to use
Returns WebGLProgram
the new webGL program
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112285

createTexture

createTexture(
    url: Nullable<string>,
    noMipmap: boolean,
    invertY: boolean,
    scene: Nullable<ISceneLike>,
    samplingMode?: number,
    onLoad?: Nullable<(texture: InternalTexture) => void>,
    onError?: Nullable<(message: string, exception: any) => void>,
    buffer?: Nullable<
        | string
        | ArrayBufferView
        | ArrayBuffer
        | Blob
        | ImageBitmap
        | HTMLImageElement,
    >,
    fallback?: Nullable<InternalTexture>,
    format?: Nullable<number>,
    forcedExtension?: Nullable<string>,
    mimeType?: string,
    loaderOptions?: any,
    creationFlags?: number,
    useSRGBBuffer?: boolean,
): InternalTexture
Usually called from Texture.ts. Passed information to create a WebGLTexture
Parameters
- url: Nullable<string>
  defines a value which contains one of the following:
  
  A conventional http URL, e.g. 'http://...' or 'file://...'
  
  A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  
  An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
- noMipmap: boolean
  defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
- invertY: boolean
  when true, image is flipped when loaded. You probably want true. Certain compressed textures may invert this if their default is inverted (eg. ktx)
- scene: Nullable<ISceneLike>
  needed for loading to the correct scene
- OptionalsamplingMode: number
  mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
- OptionalonLoad: Nullable<(texture: InternalTexture) => void>
  optional callback to be called upon successful completion
- OptionalonError: Nullable<(message: string, exception: any) => void>
  optional callback to be called upon failure
- Optionalbuffer: Nullable<
      | string
      | ArrayBufferView
      | ArrayBuffer
      | Blob
      | ImageBitmap
      | HTMLImageElement,
  >
  a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), HTMLImageElement (image format), or a Blob
- Optionalfallback: Nullable<InternalTexture>
  an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
- Optionalformat: Nullable<number>
  internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
- OptionalforcedExtension: Nullable<string>
  defines the extension to use to pick the right loader
- OptionalmimeType: string
  defines an optional mime type
- OptionalloaderOptions: any
  options to be passed to the loader
- OptionalcreationFlags: number
  specific flags to use when creating the texture (Constants.TEXTURE_CREATIONFLAG_STORAGE for storage textures, for eg)
- OptionaluseSRGBBuffer: boolean
  defines if the texture must be loaded in a sRGB GPU buffer (if supported by the GPU).
Returns InternalTexture
a InternalTexture for assignment back into BABYLON.Texture
Overrides AbstractEngine.createTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112607

createUniformBuffer

createUniformBuffer(elements: FloatArray, label?: string): DataBuffer
Create an uniform buffer
Parameters
- elements: FloatArray
  defines the content of the uniform buffer
- Optionallabel: string
  defines a name for the buffer (for debugging purpose)
Returns DataBuffer
the webGL uniform buffer

See
https://doc.babylonjs.com/setup/support/webGL2#uniform-buffer-objets
Inherited from AbstractEngine.createUniformBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:121767

createVertexBuffer

createVertexBuffer(
    data: number | DataArray,
    _updatable?: boolean,
    _label?: string,
): DataBuffer
Creates a vertex buffer
Parameters
- data: number | DataArray
  the data or size for the vertex buffer
- Optional_updatable: boolean
  whether the buffer should be created as updatable
- Optional_label: string
  defines the label of the buffer (for debug purpose)
Returns DataBuffer
the new WebGL static buffer
Overrides AbstractEngine.createVertexBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112064

createVideoElement

createVideoElement(constraints: MediaTrackConstraints): any
creates and returns a new video element
Parameters
- constraints: MediaTrackConstraints
  video constraints
Returns any
video element
Inherited from AbstractEngine.createVideoElement
- Defined in .temp/typedoc/docdirectory/doc.d.ts:117115

deleteQuery

deleteQuery(query: OcclusionQuery): AbstractEngine
Delete and release a webGL query
Parameters
- query: OcclusionQuery
  defines the query to delete
Returns AbstractEngine
the current engine
Inherited from AbstractEngine.deleteQuery
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122839

disableAttributeByIndex

disableAttributeByIndex(attributeLocation: number): void
Disable the attribute corresponding to the location in parameter
Parameters
- attributeLocation: number
  defines the attribute location of the attribute to disable
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112186

disableInstanceAttribute

disableInstanceAttribute(attributeLocation: number): void
Disable the instance attribute corresponding to the location in parameter
Parameters
- attributeLocation: number
  defines the attribute location of the attribute to disable
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112181

disableInstanceAttributeByName

disableInstanceAttributeByName(name: string): void
Disable the instance attribute corresponding to the name in parameter
Parameters
- name: string
  defines the name of the attribute to disable
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112176

displayLoadingUI

displayLoadingUI(): void
Display the loading screen

Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/scene/customLoadingScreen
Inherited from AbstractEngine.displayLoadingUI
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122922

dispose

dispose(): void
Dispose and release all associated resources

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

draw

draw(
    useTriangles: boolean,
    indexStart: number,
    indexCount: number,
    instancesCount?: number,
): void
Send a draw order
Parameters
- useTriangles: boolean
  defines if triangles must be used to draw (else wireframe will be used)
- indexStart: number
  defines the starting index
- indexCount: number
  defines the number of index to draw
- OptionalinstancesCount: number
  defines the number of instances to draw (if instantiation is enabled)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112194

drawArraysType

drawArraysType(
    fillMode: number,
    verticesStart: number,
    verticesCount: number,
    instancesCount?: number,
): void
Draw a list of unindexed primitives
Parameters
- fillMode: number
  defines the primitive to use
- verticesStart: number
  defines the index of first vertex to draw
- verticesCount: number
  defines the count of vertices to draw
- OptionalinstancesCount: number
  defines the number of instances to draw (if instantiation is enabled)
Returns void
Overrides AbstractEngine.drawArraysType
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112225

drawElementsType

drawElementsType(
    fillMode: number,
    indexStart: number,
    indexCount: number,
    instancesCount?: number,
): void
Draw a list of indexed primitives
Parameters
- fillMode: number
  defines the primitive to use
- indexStart: number
  defines the starting index
- indexCount: number
  defines the number of index to draw
- OptionalinstancesCount: number
  defines the number of instances to draw (if instantiation is enabled)
Returns void
Overrides AbstractEngine.drawElementsType
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112217

drawPointClouds

drawPointClouds(
    verticesStart: number,
    verticesCount: number,
    instancesCount?: number,
): void
Draw a list of points
Parameters
- verticesStart: number
  defines the index of first vertex to draw
- verticesCount: number
  defines the count of vertices to draw
- OptionalinstancesCount: number
  defines the number of instances to draw (if instantiation is enabled)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112201

drawUnIndexed

drawUnIndexed(
    useTriangles: boolean,
    verticesStart: number,
    verticesCount: number,
    instancesCount?: number,
): void
Draw a list of unindexed primitives
Parameters
- useTriangles: boolean
  defines if triangles must be used to draw (else wireframe will be used)
- verticesStart: number
  defines the index of first vertex to draw
- verticesCount: number
  defines the count of vertices to draw
- OptionalinstancesCount: number
  defines the number of instances to draw (if instantiation is enabled)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112209

enableEffect

enableEffect(effect: Nullable<Effect | DrawWrapper>): void
Activates an effect, making it the current one (ie. the one used for rendering)
Parameters
- effect: Nullable<Effect | DrawWrapper>
  defines the effect to activate
Returns void
Overrides AbstractEngine.enableEffect
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112340

endFrame

endFrame(): void
End the current frame

Returns void
Overrides AbstractEngine.endFrame
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111989

endOcclusionQuery

endOcclusionQuery(algorithmType: number): AbstractEngine
Ends an occlusion query
Parameters
- algorithmType: number
  defines the algorithm to use
Returns AbstractEngine
the current engine

See
https://doc.babylonjs.com/features/featuresDeepDive/occlusionQueries
Inherited from AbstractEngine.endOcclusionQuery
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122865

endTimeQuery

endTimeQuery(token: _TimeToken): number
Ends a time query
Parameters
- token: _TimeToken
  defines the token used to measure the time span
Returns number
the time spent (in ns)
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122096

enterFullscreen

enterFullscreen(requestPointerLock: boolean): void
Enters full screen mode
Parameters
- requestPointerLock: boolean
  defines if a pointer lock should be requested from the user
Returns void
Inherited from AbstractEngine.enterFullscreen
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122992

exitFullscreen

exitFullscreen(): void
Exits full screen mode

Returns void
Inherited from AbstractEngine.exitFullscreen
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122996

extractDriverInfo

extractDriverInfo(): string
Gets driver info if available

Returns string
Overrides AbstractEngine.extractDriverInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111961

flushFramebuffer

flushFramebuffer(): void
Force a webGL flush (ie. a flush of all waiting webGL commands)

Returns void
Overrides AbstractEngine.flushFramebuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112050

generateMipmaps

generateMipmaps(texture: InternalTexture): void
Generates the mipmaps for a texture
Parameters
- texture: InternalTexture
  texture to generate the mipmaps for
Returns void
Overrides AbstractEngine.generateMipmaps
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112028

generateMipMapsForCubemap

generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void
Force the mipmap generation for the given render target texture
Parameters
- texture: InternalTexture
  defines the render target texture to use
- Optionalunbind: boolean
  defines whether or not to unbind the texture after generation. Defaults to true.
Returns void
Inherited from AbstractEngine.generateMipMapsForCubemap
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120250
generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void
Force the mipmap generation for the given render target texture
Parameters
- texture: InternalTexture
  defines the render target texture to use
- Optionalunbind: boolean
  defines whether or not to unbind the texture after generation. Defaults to true.
Returns void
Inherited from AbstractEngine.generateMipMapsForCubemap
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122379

generateMipMapsFramebuffer

generateMipMapsFramebuffer(texture: RenderTargetWrapper): void
Generates mipmaps for the texture of the (single) render target
Parameters
- texture: RenderTargetWrapper
  The render target containing the texture to generate the mipmaps for
Returns void
Overrides AbstractEngine.generateMipMapsFramebuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112040

generateMipMapsMultiFramebuffer

generateMipMapsMultiFramebuffer(texture: RenderTargetWrapper): void
Generates mipmaps for the texture of the (multi) render target
Parameters
- texture: RenderTargetWrapper
  The render target containing the textures to generate the mipmaps for
Returns void
Inherited from AbstractEngine.generateMipMapsMultiFramebuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120116
generateMipMapsMultiFramebuffer(texture: RenderTargetWrapper): void
Generates mipmaps for the texture of the (multi) render target
Parameters
- texture: RenderTargetWrapper
  The render target containing the textures to generate the mipmaps for
Returns void
Inherited from AbstractEngine.generateMipMapsMultiFramebuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122224

getAlphaEquation

getAlphaEquation(): number
Gets the current alpha equation.

Returns number
the current alpha equation
Inherited from AbstractEngine.getAlphaEquation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122780

getAlphaMode

getAlphaMode(): number
Gets the current alpha mode

Returns number
the current alpha mode

See
https://doc.babylonjs.com/features/featuresDeepDive/materials/advanced/transparent_rendering
Inherited from AbstractEngine.getAlphaMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122775

getAspectRatio

getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number
Gets current aspect ratio
Parameters
- viewportOwner: IViewportOwnerLike
  defines the camera to use to get the aspect ratio
- OptionaluseScreen: boolean
  defines if screen size must be used (or the current render target if any)
Returns number
a number defining the aspect ratio
Inherited from AbstractEngine.getAspectRatio
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122977

getAttributes

getAttributes(
pipelineContext: IPipelineContext,
attributesNames: string[],
): number[]
Gets the list of active attributes for a given webGL program
Parameters
- pipelineContext: IPipelineContext
  defines the pipeline context to use
- attributesNames: string[]
  defines the list of attribute names to get
Returns number[]
an array of indices indicating the offset of each attribute
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112335

getAudioContext

getAudioContext(): Nullable<AudioContext>
Gets the audio context specified in engine initialization options

Returns Nullable<AudioContext>
an Audio Context

Deprecated
please use AudioEngineV2 instead
Inherited from AbstractEngine.getAudioContext
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116882

getAudioDestination

getAudioDestination(): Nullable<
AudioDestinationNode
| MediaStreamAudioDestinationNode,
>
Gets the audio destination specified in engine initialization options

Returns Nullable<AudioDestinationNode | MediaStreamAudioDestinationNode>
an audio destination node

Deprecated
please use AudioEngineV2 instead
Inherited from AbstractEngine.getAudioDestination
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116888

getCaps

getCaps(): EngineCapabilities
Gets the object containing all engine capabilities

Returns EngineCapabilities
the EngineCapabilities object
Inherited from AbstractEngine.getCaps
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116844

getClassName

getClassName(): string
Gets a string identifying the name of the class

Returns string
"Engine" string
Overrides AbstractEngine.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111939

getColorWrite

getColorWrite(): boolean
Gets a boolean indicating if color writing is enabled

Returns boolean
the current color writing state
Inherited from AbstractEngine.getColorWrite
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116278

getCreationOptions

getCreationOptions(): AbstractEngineOptions
Gets the options used for engine creation

Returns AbstractEngineOptions
EngineOptions object
Inherited from AbstractEngine.getCreationOptions
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116935

getCurrentRenderPassName

getCurrentRenderPassName(): string
Gets the name of the current render pass

Returns string
name of the current render pass
Inherited from AbstractEngine.getCurrentRenderPassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122794

getDeltaTime

getDeltaTime(): number
Gets the time spent between current and previous frame

Returns number
a number representing the delta time in ms
Inherited from AbstractEngine.getDeltaTime
- Defined in .temp/typedoc/docdirectory/doc.d.ts:117133

getDepthBuffer

getDepthBuffer(): boolean
Gets a boolean indicating if depth testing is enabled

Returns boolean
the current state
Inherited from AbstractEngine.getDepthBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116446

getDepthFunction

getDepthFunction(): Nullable<number>
Gets the current depth function

Returns Nullable<number>
a number defining the depth function
Inherited from AbstractEngine.getDepthFunction
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122642

getDepthWrite

getDepthWrite(): boolean
Gets a boolean indicating if depth writing is enabled

Returns boolean
the current depth writing state
Inherited from AbstractEngine.getDepthWrite
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122668

getError

getError(): number
Get the current error code of the webGL context

Returns number
the error code

See
https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
Overrides AbstractEngine.getError
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112781

getFontOffset

getFontOffset(font: string): { ascent: number; descent: number; height: number }
Get Font size information
Parameters
- font: string
  font name
Returns { ascent: number; descent: number; height: number }
Inherited from AbstractEngine.getFontOffset
- Defined in .temp/typedoc/docdirectory/doc.d.ts:117186

getFps

getFps(): number
Gets the current framerate

Returns number
a number representing the framerate
Inherited from AbstractEngine.getFps
- Defined in .temp/typedoc/docdirectory/doc.d.ts:117128

getGlInfo

getGlInfo(): { renderer: string; vendor: string; version: string }
Gets an object containing information about the current webGL context

Returns { renderer: string; vendor: string; version: string }
an object containing the vendor, the renderer and the version of the current webGL context
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111955

getGPUFrameTimeCounter

getGPUFrameTimeCounter(): PerfCounter
Get the performance counter associated with the frame time computation

Returns PerfCounter
the perf counter
Inherited from AbstractEngine.getGPUFrameTimeCounter
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122601

getHardwareScalingLevel

getHardwareScalingLevel(): number
Gets the current hardware scaling level. By default the hardware scaling level is computed from the window device ratio. if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.

Returns number
a number indicating the current hardware scaling level
Inherited from AbstractEngine.getHardwareScalingLevel
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116914

getHostDocument

getHostDocument(): Nullable<Document>
Gets host document

Returns Nullable<Document>
the host document object
Inherited from AbstractEngine.getHostDocument
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116817

getHostWindow

getHostWindow(): Nullable<Window>
Gets host window

Returns Nullable<Window>
the host window object
Inherited from AbstractEngine.getHostWindow
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116476

getInfo

getInfo(): { renderer: string; vendor: string; version: string }
Gets an object containing information about the current engine context

Returns { renderer: string; vendor: string; version: string }
an object containing the vendor, the renderer and the version of the current engine context
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111946

getInputElement

getInputElement(): Nullable<HTMLElement>
Gets the HTML element used to attach event listeners

Returns Nullable<HTMLElement>
a HTML element
Inherited from AbstractEngine.getInputElement
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122960

getInputElementClientRect

getInputElementClientRect(): Nullable<ClientRect>
Gets the client rect of the HTML element used for events

Returns Nullable<ClientRect>
a client rectangle
Inherited from AbstractEngine.getInputElementClientRect
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122970

getLoadedTexturesCache

getLoadedTexturesCache(): InternalTexture[]
Gets the list of loaded textures

Returns InternalTexture[]
an array containing all loaded textures
Inherited from AbstractEngine.getLoadedTexturesCache
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116830

getLockstepMaxSteps

getLockstepMaxSteps(): number
Gets the max steps when engine is running in deterministic lock step

Returns number
the max steps

See
https://doc.babylonjs.com/features/featuresDeepDive/animation/advanced_animations#deterministic-lockstep
Inherited from AbstractEngine.getLockstepMaxSteps
- Defined in .temp/typedoc/docdirectory/doc.d.ts:117151

getQueryResult

getQueryResult(query: OcclusionQuery): number
Gets the value of a given query
Parameters
- query: OcclusionQuery
  defines the query to check
Returns number
the value of the query
Inherited from AbstractEngine.getQueryResult
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122850

getRenderHeight

getRenderHeight(useScreen?: boolean): number
Gets the current render height
Parameters
- OptionaluseScreen: boolean
  defines if screen size must be used (or the current render target if any)
Returns number
a number defining the current render height
Overrides AbstractEngine.getRenderHeight
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111973

getRenderingCanvas

getRenderingCanvas(): Nullable<HTMLCanvasElement>
Gets the HTML canvas attached with the current webGL context

Returns Nullable<HTMLCanvasElement>
a HTML canvas
Inherited from AbstractEngine.getRenderingCanvas
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116876

getRenderingCanvasClientRect

getRenderingCanvasClientRect(): Nullable<ClientRect>
Gets the client rect of the HTML canvas attached with the current webGL context

Returns Nullable<ClientRect>
a client rectangle
Inherited from AbstractEngine.getRenderingCanvasClientRect
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122965

getRenderPassNames

getRenderPassNames(): string[]
Gets the names of the render passes that are currently created

Returns string[]
list of the render pass names
Inherited from AbstractEngine.getRenderPassNames
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122789

getRenderWidth

getRenderWidth(useScreen?: boolean): number
Gets the current render width
Parameters
- OptionaluseScreen: boolean
  defines if screen size must be used (or the current render target if any)
Returns number
a number defining the current render width
Overrides AbstractEngine.getRenderWidth
- Defined in .temp/typedoc/docdirectory/doc.d.ts:111967

getScreenAspectRatio

getScreenAspectRatio(): number
Gets current screen aspect ratio

Returns number
a number defining the aspect ratio
Inherited from AbstractEngine.getScreenAspectRatio
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122982

getStencilBuffer

getStencilBuffer(): boolean
Gets a boolean indicating if stencil buffer is enabled

Returns boolean
the current stencil buffer state
Inherited from AbstractEngine.getStencilBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122683

getStencilFunction

getStencilFunction(): number
Gets the current stencil function

Returns number
a number defining the stencil function to use
Inherited from AbstractEngine.getStencilFunction
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122703

getStencilFunctionMask

getStencilFunctionMask(): number
Gets the current stencil mask

Returns number
a number defining the stencil mask to use
Inherited from AbstractEngine.getStencilFunctionMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122713

getStencilFunctionReference

getStencilFunctionReference(): number
Gets the current stencil reference value

Returns number
a number defining the stencil reference value to use
Inherited from AbstractEngine.getStencilFunctionReference
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122708

getStencilMask

getStencilMask(): number
Gets the current stencil mask

Returns number
a number defining the new stencil mask to use
Inherited from AbstractEngine.getStencilMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122693

getStencilOperationDepthFail

getStencilOperationDepthFail(): number
Gets the current stencil operation when depth fails

Returns number
a number defining stencil operation to use when depth fails
Inherited from AbstractEngine.getStencilOperationDepthFail
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122738

getStencilOperationFail

getStencilOperationFail(): number
Gets the current stencil operation when stencil fails

Returns number
a number defining stencil operation to use when stencil fails
Inherited from AbstractEngine.getStencilOperationFail
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122733

getStencilOperationPass

getStencilOperationPass(): number
Gets the current stencil operation when stencil passes

Returns number
a number defining stencil operation to use when stencil passes
Inherited from AbstractEngine.getStencilOperationPass
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122678

getTimeStep

getTimeStep(): number
Returns the time in ms between steps when using deterministic lock step.

Returns number
time step in (ms)
Inherited from AbstractEngine.getTimeStep
- Defined in .temp/typedoc/docdirectory/doc.d.ts:117156

getUniforms

getUniforms(
pipelineContext: IPipelineContext,
uniformsNames: string[],
): Nullable<WebGLUniformLocation>[]
Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
Parameters
- pipelineContext: IPipelineContext
  defines the pipeline context to use
- uniformsNames: string[]
  defines the list of uniform names
Returns Nullable<WebGLUniformLocation>[]
an array of webGL uniform locations
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112328

getZOffset

getZOffset(): number
Gets the current value of the zOffset Factor

Returns number
the current zOffset Factor state
Inherited from AbstractEngine.getZOffset
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116461

getZOffsetUnits

getZOffsetUnits(): number
Gets the current value of the zOffset Units

Returns number
the current zOffset Units state
Inherited from AbstractEngine.getZOffsetUnits
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116471

hideLoadingUI

hideLoadingUI(): void
Hide the loading screen

Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/scene/customLoadingScreen
Inherited from AbstractEngine.hideLoadingUI
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122927

inlineShaderCode

inlineShaderCode(code: string): string
Inline functions in shader code that are marked to be inlined
Parameters
- code: string
  code to inline
Returns string
inlined code
Overrides AbstractEngine.inlineShaderCode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112291

isDeterministicLockStep

isDeterministicLockStep(): boolean
Gets a boolean indicating that the engine is running in deterministic lock step mode

Returns boolean
true if engine is in deterministic lock step mode

See
https://doc.babylonjs.com/features/featuresDeepDive/animation/advanced_animations#deterministic-lockstep
Inherited from AbstractEngine.isDeterministicLockStep
- Defined in .temp/typedoc/docdirectory/doc.d.ts:117145

isQueryResultAvailable

isQueryResultAvailable(query: OcclusionQuery): boolean
Parameters
- query: OcclusionQuery
Returns boolean
Inherited from AbstractEngine.isQueryResultAvailable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122844

readPixels

readPixels(
    x: number,
    y: number,
    width: number,
    height: number,
    hasAlpha?: boolean,
    flushRenderer?: boolean,
    data?: Nullable<Uint8Array>,
): Promise<ArrayBufferView>
Reads pixels from the current frame buffer. Please note that this function can be slow
Parameters
- x: number
  defines the x coordinate of the rectangle where pixels must be read
- y: number
  defines the y coordinate of the rectangle where pixels must be read
- width: number
  defines the width of the rectangle where pixels must be read
- height: number
  defines the height of the rectangle where pixels must be read
- OptionalhasAlpha: boolean
  defines whether the output should have alpha or not (defaults to true)
- OptionalflushRenderer: boolean
  true to flush the renderer from the pending commands before reading the pixels
- Optionaldata: Nullable<Uint8Array>
  defines the data to fill with the read pixels (if not provided, a new one will be created)
Returns Promise<ArrayBufferView>
a ArrayBufferView promise (Uint8Array) containing RGBA colors
Overrides AbstractEngine.readPixels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112808

recordVertexArrayObject

recordVertexArrayObject(
    vertexBuffers: { [key: string]: VertexBuffer },
    indexBuffer: Nullable<DataBuffer>,
    effect: Effect,
    overrideVertexBuffers?: { [kind: string]: Nullable<VertexBuffer> },
): WebGLVertexArrayObject
Records a vertex array object
Parameters
- vertexBuffers: { [key: string]: VertexBuffer }
  defines the list of vertex buffers to store
- indexBuffer: Nullable<DataBuffer>
  defines the index buffer to store
- effect: Effect
  defines the effect to store
- OptionaloverrideVertexBuffers: { [kind: string]: Nullable<VertexBuffer> }
  defines optional list of avertex buffers that overrides the entries in vertexBuffers
Returns WebGLVertexArrayObject
the new vertex array object

See
https://doc.babylonjs.com/setup/support/webGL2#vertex-array-objects
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112110

registerView

registerView(
    canvas: HTMLCanvasElement,
    camera?: Camera | Camera[],
    clearBeforeCopy?: boolean,
): EngineView
Register a new child canvas
Parameters
- canvas: HTMLCanvasElement
  defines the canvas to register
- Optionalcamera: Camera | Camera[]
  defines an optional camera or array of cameras to use with this canvas (it will overwrite the scene.activeCamera / scene.activeCameras for this view). Support for array of cameras
- OptionalclearBeforeCopy: boolean
  Indicates if the destination view canvas should be cleared before copying the parent canvas. Can help if the scene clear color has alpha < 1
Returns EngineView
the associated view

Since
Inherited from AbstractEngine.registerView
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122580

releaseComputeEffects

releaseComputeEffects(): void
Forces the engine to release all cached compute effects. This means that next effect compilation will have to be done completely even if a similar effect was already compiled

Returns void
Inherited from AbstractEngine.releaseComputeEffects
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122496

releaseEffects

releaseEffects(): void
Force the engine to release all cached effects. This means that next effect compilation will have to be done completely even if a similar effect was already compiled

Returns void
Overrides AbstractEngine.releaseEffects
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112761

releaseRenderPassId

releaseRenderPassId(id: number): void
Releases a render pass id
Parameters
- id: number
  id of the render pass to release
Returns void
Inherited from AbstractEngine.releaseRenderPassId
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122805

releaseVertexArrayObject

releaseVertexArrayObject(vao: WebGLVertexArrayObject): void
Release and free the memory of a vertex array object
Parameters
- vao: WebGLVertexArrayObject
  defines the vertex array object to delete
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112152

resetTextureCache

resetTextureCache(): void
Reset the texture cache to empty state

Returns void
Inherited from AbstractEngine.resetTextureCache
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116848

resize

resize(forceSetSize?: boolean): void
Resize the view according to the canvas' size
Parameters
- OptionalforceSetSize: boolean
  true to force setting the sizes of the underlying canvas
Returns void
Inherited from AbstractEngine.resize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116947

resizeImageBitmap

resizeImageBitmap(
    image: ImageBitmap | HTMLImageElement,
    bufferWidth: number,
    bufferHeight: number,
): Uint8Array
Resize an image and returns the image data as an uint8array
Parameters
- image: ImageBitmap | HTMLImageElement
  image to resize
- bufferWidth: number
  destination buffer width
- bufferHeight: number
  destination buffer height
Returns Uint8Array
Inherited from AbstractEngine.resizeImageBitmap
- Defined in .temp/typedoc/docdirectory/doc.d.ts:117176

resolveFramebuffer

resolveFramebuffer(texture: RenderTargetWrapper): void
Resolves the MSAA texture of the (single) render target into its non-MSAA version. Note that if "texture" is not a MSAA render target, no resolve is performed.
Parameters
- texture: RenderTargetWrapper
  The render target texture containing the MSAA textures to resolve
Returns void
Overrides AbstractEngine.resolveFramebuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112046

resolveMultiFramebuffer

resolveMultiFramebuffer(texture: RenderTargetWrapper): void
Resolves the MSAA textures of the (multi) render target into their non-MSAA version. Note that if "texture" is not a MSAA render target, no resolve is performed.
Parameters
- texture: RenderTargetWrapper
  The render target texture containing the MSAA textures to resolve
Returns void
Inherited from AbstractEngine.resolveMultiFramebuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120122
resolveMultiFramebuffer(texture: RenderTargetWrapper): void
Resolves the MSAA textures of the (multi) render target into their non-MSAA version. Note that if "texture" is not a MSAA render target, no resolve is performed.
Parameters
- texture: RenderTargetWrapper
  The render target texture containing the MSAA textures to resolve
Returns void
Inherited from AbstractEngine.resolveMultiFramebuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122230

restoreDefaultFramebuffer

restoreDefaultFramebuffer(): void
Unbind the current render target and bind the default framebuffer

Returns void
Overrides AbstractEngine.restoreDefaultFramebuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112054

restoreSingleAttachment

restoreSingleAttachment(): void
Restores the webgl state to only draw on the main color attachment when the frame buffer associated is the canvas frame buffer

Returns void
Inherited from AbstractEngine.restoreSingleAttachment
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120138
restoreSingleAttachment(): void
Restores the webgl state to only draw on the main color attachment when the frame buffer associated is the canvas frame buffer

Returns void
Inherited from AbstractEngine.restoreSingleAttachment
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122246

restoreSingleAttachmentForRenderTarget

restoreSingleAttachmentForRenderTarget(): void
Restores the webgl state to only draw on the main color attachment when the frame buffer associated is not the canvas frame buffer

Returns void
Inherited from AbstractEngine.restoreSingleAttachmentForRenderTarget
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120143
restoreSingleAttachmentForRenderTarget(): void
Restores the webgl state to only draw on the main color attachment when the frame buffer associated is not the canvas frame buffer

Returns void
Inherited from AbstractEngine.restoreSingleAttachmentForRenderTarget
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122251

restoreStencilState

restoreStencilState(): void
Restores the state of the stencil buffer

Returns void
Inherited from AbstractEngine.restoreStencilState
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122761

runRenderLoop

runRenderLoop(renderFunction: () => void): void
Register and execute a render loop. The engine can have more than one render function
Parameters
- renderFunction: () => void
  defines the function to continuously execute
Returns void
Inherited from AbstractEngine.runRenderLoop
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116441

setAlphaConstants

setAlphaConstants(r: number, g: number, b: number, a: number): void
Sets alpha constants used by some alpha blending modes
Parameters
- r: number
  defines the red component
- g: number
  defines the green component
- b: number
  defines the blue component
- a: number
  defines the alpha component
Returns void
Inherited from AbstractEngine.setAlphaConstants
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122769

setAlphaEquation

setAlphaEquation(equation: number): void
Sets the current alpha equation
Parameters
- equation: number
  defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
Returns void
Inherited from AbstractEngine.setAlphaEquation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:123023

setAlphaMode

setAlphaMode(mode: number, noDepthWriteChange?: boolean): void
Sets the current alpha mode
Parameters
- mode: number
  defines the mode to use (one of the Engine.ALPHA_XXX)
- OptionalnoDepthWriteChange: boolean
  defines if depth writing state should remains unchanged (false by default)
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/materials/advanced/transparent_rendering
Inherited from AbstractEngine.setAlphaMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120271
setAlphaMode(mode: number, noDepthWriteChange?: boolean): void
Sets the current alpha mode
Parameters
- mode: number
  defines the mode to use (one of the Engine.ALPHA_XXX)
- OptionalnoDepthWriteChange: boolean
  defines if depth writing state should remains unchanged (false by default)
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/materials/advanced/transparent_rendering
Inherited from AbstractEngine.setAlphaMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122517

setArray

setArray(uniform: Nullable<WebGLUniformLocation>, array: FloatArray): boolean
Set the value of an uniform to an array of number
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- array: FloatArray
  defines the array of number to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112471

setArray2

setArray2(uniform: Nullable<WebGLUniformLocation>, array: FloatArray): boolean
Set the value of an uniform to an array of number (stored as vec2)
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- array: FloatArray
  defines the array of number to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112478

setArray3

setArray3(uniform: Nullable<WebGLUniformLocation>, array: FloatArray): boolean
Set the value of an uniform to an array of number (stored as vec3)
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- array: FloatArray
  defines the array of number to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112485

setArray4

setArray4(uniform: Nullable<WebGLUniformLocation>, array: FloatArray): boolean
Set the value of an uniform to an array of number (stored as vec4)
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- array: FloatArray
  defines the array of number to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112492

setColorWrite

setColorWrite(enable: boolean): void
Enable or disable color writing
Parameters
- enable: boolean
  defines the state to set
Returns void
Inherited from AbstractEngine.setColorWrite
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116273

setDepthBuffer

setDepthBuffer(enable: boolean): void
Enable or disable depth buffering
Parameters
- enable: boolean
  defines the state to set
Returns void
Inherited from AbstractEngine.setDepthBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116451

setDepthFunction

setDepthFunction(depthFunc: number): void
Sets the current depth function
Parameters
- depthFunc: number
  defines the function to use
Returns void
Inherited from AbstractEngine.setDepthFunction
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122647

setDepthFunctionToGreater

setDepthFunctionToGreater(): void
Sets the current depth function to GREATER

Returns void
Inherited from AbstractEngine.setDepthFunctionToGreater
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122651

setDepthFunctionToGreaterOrEqual

setDepthFunctionToGreaterOrEqual(): void
Sets the current depth function to GEQUAL

Returns void
Inherited from AbstractEngine.setDepthFunctionToGreaterOrEqual
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122655

setDepthFunctionToLess

setDepthFunctionToLess(): void
Sets the current depth function to LESS

Returns void
Inherited from AbstractEngine.setDepthFunctionToLess
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122659

setDepthFunctionToLessOrEqual

setDepthFunctionToLessOrEqual(): void
Sets the current depth function to LEQUAL

Returns void
Inherited from AbstractEngine.setDepthFunctionToLessOrEqual
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122663

setDepthStencilTexture

setDepthStencilTexture(
    channel: number,
    uniform: Nullable<WebGLUniformLocation>,
    texture: Nullable<RenderTargetTexture>,
    name?: string,
): void
Sets a depth stencil texture from a render target to the according uniform.
Parameters
- channel: number
  The texture channel
- uniform: Nullable<WebGLUniformLocation>
  The uniform to set
- texture: Nullable<RenderTargetTexture>
  The render target texture containing the depth stencil texture to apply
- Optionalname: string
  The texture name
Returns void
Inherited from AbstractEngine.setDepthStencilTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:119901
setDepthStencilTexture(
    channel: number,
    uniform: Nullable<WebGLUniformLocation>,
    texture: Nullable<RenderTargetTexture>,
    name?: string,
): void
Sets a depth stencil texture from a render target to the according uniform.
Parameters
- channel: number
  The texture channel
- uniform: Nullable<WebGLUniformLocation>
  The uniform to set
- texture: Nullable<RenderTargetTexture>
  The render target texture containing the depth stencil texture to apply
- Optionalname: string
  The texture name
Returns void
Inherited from AbstractEngine.setDepthStencilTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:121906

setDepthWrite

setDepthWrite(enable: boolean): void
Enable or disable depth writing
Parameters
- enable: boolean
  defines the state to set
Returns void
Inherited from AbstractEngine.setDepthWrite
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122673

setFloat

setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): boolean
Set the value of an uniform to a number (float)
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- value: number
  defines the float number to store
Returns boolean
true if the value was transferred
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112520

setFloat2

setFloat2(
    uniform: Nullable<WebGLUniformLocation>,
    x: number,
    y: number,
): boolean
Set the value of an uniform to a vec2
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- x: number
  defines the 1st component of the value
- y: number
  defines the 2nd component of the value
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112528

setFloat3

setFloat3(
    uniform: Nullable<WebGLUniformLocation>,
    x: number,
    y: number,
    z: number,
): boolean
Set the value of an uniform to a vec3
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- x: number
  defines the 1st component of the value
- y: number
  defines the 2nd component of the value
- z: number
  defines the 3rd component of the value
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112537

setFloat4

setFloat4(
    uniform: Nullable<WebGLUniformLocation>,
    x: number,
    y: number,
    z: number,
    w: number,
): boolean
Set the value of an uniform to a vec4
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- x: number
  defines the 1st component of the value
- y: number
  defines the 2nd component of the value
- z: number
  defines the 3rd component of the value
- w: number
  defines the 4th component of the value
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112547

setHardwareScalingLevel

setHardwareScalingLevel(level: number): void
Defines the hardware scaling level. By default the hardware scaling level is computed from the window device ratio. if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
Parameters
- level: number
  defines the level to use
Returns void
Inherited from AbstractEngine.setHardwareScalingLevel
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116907

setInt

setInt(uniform: Nullable<WebGLUniformLocation>, value: number): boolean
Set the value of an uniform to a number (int)
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- value: number
  defines the int number to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112347

setInt2

setInt2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): boolean
Set the value of an uniform to a int2
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- x: number
  defines the 1st component of the value
- y: number
  defines the 2nd component of the value
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112355

setInt3

setInt3(
    uniform: Nullable<WebGLUniformLocation>,
    x: number,
    y: number,
    z: number,
): boolean
Set the value of an uniform to a int3
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- x: number
  defines the 1st component of the value
- y: number
  defines the 2nd component of the value
- z: number
  defines the 3rd component of the value
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112364

setInt4

setInt4(
    uniform: Nullable<WebGLUniformLocation>,
    x: number,
    y: number,
    z: number,
    w: number,
): boolean
Set the value of an uniform to a int4
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- x: number
  defines the 1st component of the value
- y: number
  defines the 2nd component of the value
- z: number
  defines the 3rd component of the value
- w: number
  defines the 4th component of the value
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112374

setIntArray

setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean
Set the value of an uniform to an array of int32
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- array: Int32Array
  defines the array of int32 to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112381

setIntArray2

setIntArray2(
uniform: Nullable<WebGLUniformLocation>,
array: Int32Array,
): boolean
Set the value of an uniform to an array of int32 (stored as vec2)
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- array: Int32Array
  defines the array of int32 to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112388

setIntArray3

setIntArray3(
uniform: Nullable<WebGLUniformLocation>,
array: Int32Array,
): boolean
Set the value of an uniform to an array of int32 (stored as vec3)
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- array: Int32Array
  defines the array of int32 to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112395

setIntArray4

setIntArray4(
uniform: Nullable<WebGLUniformLocation>,
array: Int32Array,
): boolean
Set the value of an uniform to an array of int32 (stored as vec4)
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- array: Int32Array
  defines the array of int32 to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112402

setMatrices

setMatrices(
uniform: Nullable<WebGLUniformLocation>,
matrices: DeepImmutableArray<number> | DeepImmutableObject<Float32Array>,
): boolean
Set the value of an uniform to an array of float32 (stored as matrices)
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- matrices: DeepImmutableArray<number> | DeepImmutableObject<Float32Array>
  defines the array of float32 to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112499

setMatrix2x2

setMatrix2x2(
uniform: Nullable<WebGLUniformLocation>,
matrix: Float32Array,
): boolean
Set the value of an uniform to a matrix (2x2)
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- matrix: Float32Array
  defines the Float32Array representing the 2x2 matrix to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112513

setMatrix3x3

setMatrix3x3(
uniform: Nullable<WebGLUniformLocation>,
matrix: Float32Array,
): boolean
Set the value of an uniform to a matrix (3x3)
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- matrix: Float32Array
  defines the Float32Array representing the 3x3 matrix to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112506

setSize

setSize(width: number, height: number, forceSetSize?: boolean): boolean
Force a specific size of the canvas
Parameters
- width: number
  defines the new canvas' width
- height: number
  defines the new canvas' height
- OptionalforceSetSize: boolean
  true to force setting the sizes of the underlying canvas
Returns boolean
true if the size was changed
Inherited from AbstractEngine.setSize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116955

setState

setState(
    culling: boolean,
    zOffset?: number,
    force?: boolean,
    reverseSide?: boolean,
    cullBackFaces?: boolean,
    stencil?: IStencilState,
    zOffsetUnits?: number,
): void
Set various states to the webGL context
Parameters
- culling: boolean
  defines culling state: true to enable culling, false to disable it
- OptionalzOffset: number
  defines the value to apply to zOffset (0 by default)
- Optionalforce: boolean
  defines if states must be applied even if cache is up to date
- OptionalreverseSide: boolean
  defines if culling must be reversed (CCW if false, CW if true)
- OptionalcullBackFaces: boolean
  true to cull back faces, false to cull front faces (if culling is enabled)
- Optionalstencil: IStencilState
  stencil states to set
- OptionalzOffsetUnits: number
  defines the value to apply to zOffsetUnits (0 by default)
Returns void
Overrides AbstractEngine.setState
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112017

setStateCullFaceType

setStateCullFaceType(cullBackFaces?: boolean, force?: boolean): void
Sets the type of faces to cull
Parameters
- OptionalcullBackFaces: boolean
  true to cull back faces, false to cull front faces (if culling is enabled)
- Optionalforce: boolean
  defines if states must be applied even if cache is up to date
Returns void
Overrides AbstractEngine.setStateCullFaceType
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112006

setStencilBuffer

setStencilBuffer(enable: boolean): void
Enable or disable the stencil buffer
Parameters
- enable: boolean
  defines if the stencil buffer must be enabled or disabled
Returns void
Inherited from AbstractEngine.setStencilBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122688

setStencilFunction

setStencilFunction(stencilFunc: number): void
Sets the current stencil function
Parameters
- stencilFunc: number
  defines the new stencil function to use
Returns void
Inherited from AbstractEngine.setStencilFunction
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122718

setStencilFunctionMask

setStencilFunctionMask(mask: number): void
Sets the current stencil mask
Parameters
- mask: number
  defines the new stencil mask to use
Returns void
Inherited from AbstractEngine.setStencilFunctionMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122728

setStencilFunctionReference

setStencilFunctionReference(reference: number): void
Sets the current stencil reference
Parameters
- reference: number
  defines the new stencil reference to use
Returns void
Inherited from AbstractEngine.setStencilFunctionReference
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122723

setStencilMask

setStencilMask(mask: number): void
Sets the current stencil mask
Parameters
- mask: number
  defines the new stencil mask to use
Returns void
Inherited from AbstractEngine.setStencilMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122698

setStencilOperationDepthFail

setStencilOperationDepthFail(operation: number): void
Sets the stencil operation to use when depth fails
Parameters
- operation: number
  defines the stencil operation to use when depth fails
Returns void
Inherited from AbstractEngine.setStencilOperationDepthFail
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122748

setStencilOperationFail

setStencilOperationFail(operation: number): void
Sets the stencil operation to use when stencil fails
Parameters
- operation: number
  defines the stencil operation to use when stencil fails
Returns void
Inherited from AbstractEngine.setStencilOperationFail
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122743

setStencilOperationPass

setStencilOperationPass(operation: number): void
Sets the stencil operation to use when stencil passes
Parameters
- operation: number
  defines the stencil operation to use when stencil passes
Returns void
Inherited from AbstractEngine.setStencilOperationPass
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122753

setTexture

setTexture(
    channel: number,
    uniform: Nullable<WebGLUniformLocation>,
    texture: Nullable<ThinTexture>,
    name: string,
): void
Sets a texture to the according uniform.
Parameters
- channel: number
  The texture channel
- uniform: Nullable<WebGLUniformLocation>
  The uniform to set
- texture: Nullable<ThinTexture>
  The texture to apply
- name: string
  The name of the uniform in the effect
Returns void
Overrides AbstractEngine.setTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112736

setTextureArray

setTextureArray(
    channel: number,
    uniform: Nullable<WebGLUniformLocation>,
    textures: ThinTexture[],
    name: string,
): void
Sets an array of texture to the webGL context
Parameters
- channel: number
  defines the channel where the texture array must be set
- uniform: Nullable<WebGLUniformLocation>
  defines the associated uniform location
- textures: ThinTexture[]
  defines the array of textures to bind
- name: string
  name of the channel
Returns void
Overrides AbstractEngine.setTextureArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112747

setTextureFromPostProcess

setTextureFromPostProcess(
    channel: number,
    postProcess: Nullable<PostProcess>,
    name: string,
): void
Sets a texture to the context from a postprocess
Parameters
- channel: number
  defines the channel to use
- postProcess: Nullable<PostProcess>
  defines the source postprocess
- name: string
  name of the channel
Returns void
Inherited from AbstractEngine.setTextureFromPostProcess
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22217

setTextureFromPostProcessOutput

setTextureFromPostProcessOutput(
    channel: number,
    postProcess: Nullable<PostProcess>,
    name: string,
): void
Binds the output of the passed in post process to the texture channel specified
Parameters
- channel: number
  The channel the texture should be bound to
- postProcess: Nullable<PostProcess>
  The post process which's output should be bound
- name: string
  name of the channel
Returns void
Inherited from AbstractEngine.setTextureFromPostProcessOutput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22224

setUInt

setUInt(uniform: Nullable<WebGLUniformLocation>, value: number): boolean
Set the value of an uniform to a number (unsigned int)
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- value: number
  defines the unsigned int number to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112409

setUInt2

setUInt2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): boolean
Set the value of an uniform to a unsigned int2
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- x: number
  defines the 1st component of the value
- y: number
  defines the 2nd component of the value
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112417

setUInt3

setUInt3(
    uniform: Nullable<WebGLUniformLocation>,
    x: number,
    y: number,
    z: number,
): boolean
Set the value of an uniform to a unsigned int3
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- x: number
  defines the 1st component of the value
- y: number
  defines the 2nd component of the value
- z: number
  defines the 3rd component of the value
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112426

setUInt4

setUInt4(
    uniform: Nullable<WebGLUniformLocation>,
    x: number,
    y: number,
    z: number,
    w: number,
): boolean
Set the value of an uniform to a unsigned int4
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- x: number
  defines the 1st component of the value
- y: number
  defines the 2nd component of the value
- z: number
  defines the 3rd component of the value
- w: number
  defines the 4th component of the value
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112436

setUIntArray

setUIntArray(
uniform: Nullable<WebGLUniformLocation>,
array: Uint32Array,
): boolean
Set the value of an uniform to an array of unsigned int32
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- array: Uint32Array
  defines the array of unsigned int32 to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112443

setUIntArray2

setUIntArray2(
uniform: Nullable<WebGLUniformLocation>,
array: Uint32Array,
): boolean
Set the value of an uniform to an array of unsigned int32 (stored as vec2)
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- array: Uint32Array
  defines the array of unsigned int32 to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112450

setUIntArray3

setUIntArray3(
uniform: Nullable<WebGLUniformLocation>,
array: Uint32Array,
): boolean
Set the value of an uniform to an array of unsigned int32 (stored as vec3)
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- array: Uint32Array
  defines the array of unsigned int32 to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112457

setUIntArray4

setUIntArray4(
uniform: Nullable<WebGLUniformLocation>,
array: Uint32Array,
): boolean
Set the value of an uniform to an array of unsigned int32 (stored as vec4)
Parameters
- uniform: Nullable<WebGLUniformLocation>
  defines the webGL uniform location where to store the value
- array: Uint32Array
  defines the array of unsigned int32 to store
Returns boolean
true if the value was set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112464

setViewport

setViewport(
    viewport: IViewportLike,
    requiredWidth?: number,
    requiredHeight?: number,
): void
Set the WebGL's viewport
Parameters
- viewport: IViewportLike
  defines the viewport element to be used
- OptionalrequiredWidth: number
  defines the width required for rendering. If not provided the rendering canvas' width is used
- OptionalrequiredHeight: number
  defines the height required for rendering. If not provided the rendering canvas' height is used
Returns void
Inherited from AbstractEngine.setViewport
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116721

setZOffset

setZOffset(value: number): void
Set the z offset Factor to apply to current rendering
Parameters
- value: number
  defines the offset to apply
Returns void
Inherited from AbstractEngine.setZOffset
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116456

setZOffsetUnits

setZOffsetUnits(value: number): void
Set the z offset Units to apply to current rendering
Parameters
- value: number
  defines the offset to apply
Returns void
Inherited from AbstractEngine.setZOffsetUnits
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116466

snapshotRenderingReset

snapshotRenderingReset(): void
Creates a new snapshot at the next frame using the current snapshotRenderingMode

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

startTimeQuery

startTimeQuery(): Nullable<_TimeToken>
Starts a time query (used to measure time spent by the GPU on a specific frame) Please note that only one query can be issued at a time

Returns Nullable<_TimeToken>
a time token used to track the time span
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122090

stopRenderLoop

stopRenderLoop(renderFunction?: () => void): void
stop executing a render loop function and remove it from the execution array
Parameters
- OptionalrenderFunction: () => void
  defines the function to be removed. If not provided all functions will be removed.
Returns void
Inherited from AbstractEngine.stopRenderLoop
- Defined in .temp/typedoc/docdirectory/doc.d.ts:116392

switchFullscreen

switchFullscreen(requestPointerLock: boolean): void
Toggle full screen mode
Parameters
- requestPointerLock: boolean
  defines if a pointer lock should be requested from the user
Returns void
Inherited from AbstractEngine.switchFullscreen
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122987

unbindAllAttributes

unbindAllAttributes(): void
Unbind all vertex attributes from the webGL context

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

unbindAllTextures

unbindAllTextures(): void
Unbind all textures from the webGL context

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

unBindFramebuffer

unBindFramebuffer(
    texture: RenderTargetWrapper,
    disableGenerateMipMaps?: boolean,
    onBeforeUnbind?: () => void,
): void
Unbind the current render target texture from the webGL context
Parameters
- texture: RenderTargetWrapper
  defines the render target wrapper to unbind
- OptionaldisableGenerateMipMaps: boolean
  defines a boolean indicating that mipmaps must not be generated
- OptionalonBeforeUnbind: () => void
  defines a function which will be called before the effective unbind
Returns void
Overrides AbstractEngine.unBindFramebuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112035

unbindInstanceAttributes

unbindInstanceAttributes(): void
Unbind all instance attributes

Returns void
Overrides AbstractEngine.unbindInstanceAttributes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112147

unBindMultiColorAttachmentFramebuffer

unBindMultiColorAttachmentFramebuffer(
    rtWrapper: RenderTargetWrapper,
    disableGenerateMipMaps: boolean,
    onBeforeUnbind?: () => void,
): void
Unbind a list of render target textures from the webGL context This is used only when drawBuffer extension or webGL2 are active
Parameters
- rtWrapper: RenderTargetWrapper
  defines the render target wrapper to unbind
- disableGenerateMipMaps: boolean
  defines a boolean indicating that mipmaps must not be generated
- OptionalonBeforeUnbind: () => void
  defines a function which will be called before the effective unbind
Returns void
Inherited from AbstractEngine.unBindMultiColorAttachmentFramebuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120093
unBindMultiColorAttachmentFramebuffer(
    rtWrapper: RenderTargetWrapper,
    disableGenerateMipMaps: boolean,
    onBeforeUnbind?: () => void,
): void
Unbind a list of render target textures from the webGL context This is used only when drawBuffer extension or webGL2 are active
Parameters
- rtWrapper: RenderTargetWrapper
  defines the render target wrapper to unbind
- disableGenerateMipMaps: boolean
  defines a boolean indicating that mipmaps must not be generated
- OptionalonBeforeUnbind: () => void
  defines a function which will be called before the effective unbind
Returns void
Inherited from AbstractEngine.unBindMultiColorAttachmentFramebuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122201

unRegisterView

unRegisterView(canvas: HTMLCanvasElement): AbstractEngine
Remove a registered child canvas
Parameters
- canvas: HTMLCanvasElement
  defines the canvas to remove
Returns AbstractEngine
the current engine
Inherited from AbstractEngine.unRegisterView
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122586

updateAndBindInstancesBuffer

updateAndBindInstancesBuffer(
    instancesBuffer: DataBuffer,
    data: Float32Array,
    offsetLocations: number[] | InstancingAttributeInfo[],
): void
Update the content of a webGL buffer used with instantiation and bind it to the webGL context
Parameters
- instancesBuffer: DataBuffer
  defines the webGL buffer to update and bind
- data: Float32Array
  defines the data to store in the buffer
- offsetLocations: number[] | InstancingAttributeInfo[]
  defines the offsets or attributes information used to determine where data must be stored in the buffer
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112164

updateArrayBuffer

updateArrayBuffer(data: Float32Array): void
update the bound buffer with the given data
Parameters
- data: Float32Array
  defines the data to update
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112094

updateDynamicIndexBuffer

updateDynamicIndexBuffer(
    indexBuffer: DataBuffer,
    indices: IndicesArray,
    offset?: number,
): void
Update a dynamic index buffer
Parameters
- indexBuffer: DataBuffer
  defines the target index buffer
- indices: IndicesArray
  defines the data to update
- Optionaloffset: number
  defines the offset in the target index buffer where update should start
Returns void
Inherited from AbstractEngine.updateDynamicIndexBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122286

updateDynamicTexture

updateDynamicTexture(
    texture: Nullable<InternalTexture>,
    source: ICanvas | ImageSource,
    invertY?: boolean,
    premulAlpha?: boolean,
    format?: number,
    forceBindTexture?: boolean,
    allowGPUOptimization?: boolean,
): void
Update the content of a dynamic texture
Parameters
- texture: Nullable<InternalTexture>
  defines the texture to update
- source: ICanvas | ImageSource
  defines the source containing the data
- OptionalinvertY: boolean
  defines if data must be stored with Y axis inverted
- OptionalpremulAlpha: boolean
  defines if alpha is stored as premultiplied
- Optionalformat: number
  defines the format of the data
- OptionalforceBindTexture: boolean
  if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
- OptionalallowGPUOptimization: boolean
  true to allow some specific GPU optimizations (subject to engine feature "allowGPUOptimizationsForGUI" being true)
Returns void
Inherited from AbstractEngine.updateDynamicTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120167
updateDynamicTexture(
    texture: Nullable<InternalTexture>,
    source: ICanvas | ImageSource,
    invertY?: boolean,
    premulAlpha?: boolean,
    format?: number,
    forceBindTexture?: boolean,
    allowGPUOptimization?: boolean,
): void
Update the content of a dynamic texture
Parameters
- texture: Nullable<InternalTexture>
  defines the texture to update
- source: ICanvas | ImageSource
  defines the source containing the data
- OptionalinvertY: boolean
  defines if data must be stored with Y axis inverted
- OptionalpremulAlpha: boolean
  defines if alpha is stored as premultiplied
- Optionalformat: number
  defines the format of the data
- OptionalforceBindTexture: boolean
  if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
- OptionalallowGPUOptimization: boolean
  true to allow some specific GPU optimizations (subject to engine feature "allowGPUOptimizationsForGUI" being true)
Returns void
Inherited from AbstractEngine.updateDynamicTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122275

updateDynamicVertexBuffer

updateDynamicVertexBuffer(
    vertexBuffer: DataBuffer,
    data: DataArray,
    byteOffset?: number,
    byteLength?: number,
): void
Updates a dynamic vertex buffer.
Parameters
- vertexBuffer: DataBuffer
  the vertex buffer to update
- data: DataArray
  the data used to update the vertex buffer
- OptionalbyteOffset: number
  the byte offset of the data
- OptionalbyteLength: number
  the byte length of the data
Returns void
Inherited from AbstractEngine.updateDynamicVertexBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122294

updateMultipleRenderTargetTextureSampleCount

updateMultipleRenderTargetTextureSampleCount(
    rtWrapper: Nullable<RenderTargetWrapper>,
    samples: number,
    initializeBuffers?: boolean,
): number
Update the sample count for a given multiple render target texture
Parameters
- rtWrapper: Nullable<RenderTargetWrapper>
  defines the render target wrapper to update
- samples: number
  defines the sample count to set
- OptionalinitializeBuffers: boolean
  if set to true, the engine will make an initializing call of drawBuffers
Returns number
the effective sample count (could be 0 if multisample render targets are not supported)

See
https://doc.babylonjs.com/setup/support/webGL2#multisample-render-targets
Inherited from AbstractEngine.updateMultipleRenderTargetTextureSampleCount
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120111
updateMultipleRenderTargetTextureSampleCount(
    rtWrapper: Nullable<RenderTargetWrapper>,
    samples: number,
    initializeBuffers?: boolean,
): number
Update the sample count for a given multiple render target texture
Parameters
- rtWrapper: Nullable<RenderTargetWrapper>
  defines the render target wrapper to update
- samples: number
  defines the sample count to set
- OptionalinitializeBuffers: boolean
  if set to true, the engine will make an initializing call of drawBuffers
Returns number
the effective sample count (could be 0 if multisample render targets are not supported)

See
https://doc.babylonjs.com/setup/support/webGL2#multisample-render-targets
Inherited from AbstractEngine.updateMultipleRenderTargetTextureSampleCount
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122219

updateRawCubeTexture

updateRawCubeTexture(
    texture: InternalTexture,
    data: ArrayBufferView[],
    format: number,
    type: number,
    invertY: boolean,
): void
Update a raw cube texture
Parameters
- texture: InternalTexture
  defines the texture to update
- data: ArrayBufferView[]
  defines the data to store
- format: number
  defines the data format
- type: number
  defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_BYTE by default)
- invertY: boolean
  defines if data must be stored with Y axis inverted
Returns void
Inherited from AbstractEngine.updateRawCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:119990
updateRawCubeTexture(
    texture: InternalTexture,
    data: ArrayBufferView[],
    format: number,
    type: number,
    invertY: boolean,
    compression: Nullable<string>,
): void
Update a raw cube texture
Parameters
- texture: InternalTexture
  defines the texture to update
- data: ArrayBufferView[]
  defines the data to store
- format: number
  defines the data format
- type: number
  defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_BYTE by default)
- invertY: boolean
  defines if data must be stored with Y axis inverted
- compression: Nullable<string>
  defines the compression used (null by default)
Returns void
Inherited from AbstractEngine.updateRawCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120000
updateRawCubeTexture(
    texture: InternalTexture,
    data: ArrayBufferView[],
    format: number,
    type: number,
    invertY: boolean,
    compression: Nullable<string>,
    level: number,
): void
Update a raw cube texture
Parameters
- texture: InternalTexture
  defines the texture to update
- data: ArrayBufferView[]
  defines the data to store
- format: number
  defines the data format
- type: number
  defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_BYTE by default)
- invertY: boolean
  defines if data must be stored with Y axis inverted
- compression: Nullable<string>
  defines the compression used (null by default)
- level: number
  defines which level of the texture to update
Returns void
Inherited from AbstractEngine.updateRawCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120011
updateRawCubeTexture(
    texture: InternalTexture,
    data: ArrayBufferView[],
    format: number,
    type: number,
    invertY: boolean,
): void
Update a raw cube texture
Parameters
- texture: InternalTexture
  defines the texture to update
- data: ArrayBufferView[]
  defines the data to store
- format: number
  defines the data format
- type: number
  defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_BYTE by default)
- invertY: boolean
  defines if data must be stored with Y axis inverted
Returns void
Inherited from AbstractEngine.updateRawCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:121987
updateRawCubeTexture(
    texture: InternalTexture,
    data: ArrayBufferView[],
    format: number,
    type: number,
    invertY: boolean,
    compression: Nullable<string>,
): void
Update a raw cube texture
Parameters
- texture: InternalTexture
  defines the texture to update
- data: ArrayBufferView[]
  defines the data to store
- format: number
  defines the data format
- type: number
  defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_BYTE by default)
- invertY: boolean
  defines if data must be stored with Y axis inverted
- compression: Nullable<string>
  defines the compression used (null by default)
Returns void
Inherited from AbstractEngine.updateRawCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:121997
updateRawCubeTexture(
    texture: InternalTexture,
    data: ArrayBufferView[],
    format: number,
    type: number,
    invertY: boolean,
    compression: Nullable<string>,
    level: number,
): void
Update a raw cube texture
Parameters
- texture: InternalTexture
  defines the texture to update
- data: ArrayBufferView[]
  defines the data to store
- format: number
  defines the data format
- type: number
  defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_BYTE by default)
- invertY: boolean
  defines if data must be stored with Y axis inverted
- compression: Nullable<string>
  defines the compression used (null by default)
- level: number
  defines which level of the texture to update
Returns void
Inherited from AbstractEngine.updateRawCubeTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122008

updateRawTexture

updateRawTexture(
    texture: Nullable<InternalTexture>,
    data: Nullable<ArrayBufferView>,
    format: number,
    invertY: boolean,
): void
Update a raw texture
Parameters
- texture: Nullable<InternalTexture>
  defines the texture to update
- data: Nullable<ArrayBufferView>
  defines the data to store in the texture
- format: number
  defines the format of the data
- invertY: boolean
  defines if data must be stored with Y axis inverted
Returns void
Inherited from AbstractEngine.updateRawTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:119957
updateRawTexture(
    texture: Nullable<InternalTexture>,
    data: Nullable<ArrayBufferView>,
    format: number,
    invertY: boolean,
    compression: Nullable<string>,
    type: number,
    useSRGBBuffer: boolean,
): void
Update a raw texture
Parameters
- texture: Nullable<InternalTexture>
  defines the texture to update
- data: Nullable<ArrayBufferView>
  defines the data to store in the texture
- format: number
  defines the format of the data
- invertY: boolean
  defines if data must be stored with Y axis inverted
- compression: Nullable<string>
  defines the compression used (null by default)
- type: number
  defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_BYTE by default)
- useSRGBBuffer: boolean
  defines if the texture must be loaded in a sRGB GPU buffer (if supported by the GPU).
Returns void
Inherited from AbstractEngine.updateRawTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:119968
updateRawTexture(
    texture: Nullable<InternalTexture>,
    data: Nullable<ArrayBufferView>,
    format: number,
    invertY: boolean,
): void
Update a raw texture
Parameters
- texture: Nullable<InternalTexture>
  defines the texture to update
- data: Nullable<ArrayBufferView>
  defines the data to store in the texture
- format: number
  defines the format of the data
- invertY: boolean
  defines if data must be stored with Y axis inverted
Returns void
Inherited from AbstractEngine.updateRawTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:121967
updateRawTexture(
    texture: Nullable<InternalTexture>,
    data: Nullable<ArrayBufferView>,
    format: number,
    invertY: boolean,
    compression: Nullable<string>,
    type: number,
    useSRGBBuffer: boolean,
): void
Update a raw texture
Parameters
- texture: Nullable<InternalTexture>
  defines the texture to update
- data: Nullable<ArrayBufferView>
  defines the data to store in the texture
- format: number
  defines the format of the data
- invertY: boolean
  defines if data must be stored with Y axis inverted
- compression: Nullable<string>
  defines the compression used (null by default)
- type: number
  defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_BYTE by default)
- useSRGBBuffer: boolean
  defines if the texture must be loaded in a sRGB GPU buffer (if supported by the GPU).
Returns void
Inherited from AbstractEngine.updateRawTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:121978

updateRawTexture2DArray

updateRawTexture2DArray(
    texture: InternalTexture,
    data: Nullable<ArrayBufferView>,
    format: number,
    invertY: boolean,
): void
Update a raw 2D array texture
Parameters
- texture: InternalTexture
  defines the texture to update
- data: Nullable<ArrayBufferView>
  defines the data to store
- format: number
  defines the data format
- invertY: boolean
  defines if data must be stored with Y axis inverted
Returns void
Inherited from AbstractEngine.updateRawTexture2DArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120069
updateRawTexture2DArray(
    texture: InternalTexture,
    data: Nullable<ArrayBufferView>,
    format: number,
    invertY: boolean,
    compression: Nullable<string>,
    textureType: number,
): void
Update a raw 2D array texture
Parameters
- texture: InternalTexture
  defines the texture to update
- data: Nullable<ArrayBufferView>
  defines the data to store
- format: number
  defines the data format
- invertY: boolean
  defines if data must be stored with Y axis inverted
- compression: Nullable<string>
  defines the used compression (can be null)
- textureType: number
  defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_BYTE, Engine.TEXTURETYPE_FLOAT...)
Returns void
Inherited from AbstractEngine.updateRawTexture2DArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120079
updateRawTexture2DArray(
    texture: InternalTexture,
    data: Nullable<ArrayBufferView>,
    format: number,
    invertY: boolean,
): void
Update a raw 2D array texture
Parameters
- texture: InternalTexture
  defines the texture to update
- data: Nullable<ArrayBufferView>
  defines the data to store
- format: number
  defines the data format
- invertY: boolean
  defines if data must be stored with Y axis inverted
Returns void
Inherited from AbstractEngine.updateRawTexture2DArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122066
updateRawTexture2DArray(
    texture: InternalTexture,
    data: Nullable<ArrayBufferView>,
    format: number,
    invertY: boolean,
    compression: Nullable<string>,
    textureType: number,
): void
Update a raw 2D array texture
Parameters
- texture: InternalTexture
  defines the texture to update
- data: Nullable<ArrayBufferView>
  defines the data to store
- format: number
  defines the data format
- invertY: boolean
  defines if data must be stored with Y axis inverted
- compression: Nullable<string>
  defines the used compression (can be null)
- textureType: number
  defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_BYTE, Engine.TEXTURETYPE_FLOAT...)
Returns void
Inherited from AbstractEngine.updateRawTexture2DArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122076

updateRawTexture3D

updateRawTexture3D(
    texture: InternalTexture,
    data: Nullable<ArrayBufferView>,
    format: number,
    invertY: boolean,
): void
Update a raw 3D texture
Parameters
- texture: InternalTexture
  defines the texture to update
- data: Nullable<ArrayBufferView>
  defines the data to store
- format: number
  defines the data format
- invertY: boolean
  defines if data must be stored with Y axis inverted
Returns void
Inherited from AbstractEngine.updateRawTexture3D
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120051
updateRawTexture3D(
    texture: InternalTexture,
    data: Nullable<ArrayBufferView>,
    format: number,
    invertY: boolean,
    compression: Nullable<string>,
    textureType: number,
): void
Update a raw 3D texture
Parameters
- texture: InternalTexture
  defines the texture to update
- data: Nullable<ArrayBufferView>
  defines the data to store
- format: number
  defines the data format
- invertY: boolean
  defines if data must be stored with Y axis inverted
- compression: Nullable<string>
  defines the used compression (can be null)
- textureType: number
  defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_BYTE, Engine.TEXTURETYPE_FLOAT...)
Returns void
Inherited from AbstractEngine.updateRawTexture3D
- Defined in .temp/typedoc/docdirectory/doc.d.ts:120061
updateRawTexture3D(
    texture: InternalTexture,
    data: Nullable<ArrayBufferView>,
    format: number,
    invertY: boolean,
): void
Update a raw 3D texture
Parameters
- texture: InternalTexture
  defines the texture to update
- data: Nullable<ArrayBufferView>
  defines the data to store
- format: number
  defines the data format
- invertY: boolean
  defines if data must be stored with Y axis inverted
Returns void
Inherited from AbstractEngine.updateRawTexture3D
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122048
updateRawTexture3D(
    texture: InternalTexture,
    data: Nullable<ArrayBufferView>,
    format: number,
    invertY: boolean,
    compression: Nullable<string>,
    textureType: number,
): void
Update a raw 3D texture
Parameters
- texture: InternalTexture
  defines the texture to update
- data: Nullable<ArrayBufferView>
  defines the data to store
- format: number
  defines the data format
- invertY: boolean
  defines if data must be stored with Y axis inverted
- compression: Nullable<string>
  defines the used compression (can be null)
- textureType: number
  defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_BYTE, Engine.TEXTURETYPE_FLOAT...)
Returns void
Inherited from AbstractEngine.updateRawTexture3D
- Defined in .temp/typedoc/docdirectory/doc.d.ts:122058

updateRenderTargetTextureSampleCount

updateRenderTargetTextureSampleCount(
rtWrapper: Nullable<RenderTargetWrapper>,
samples: number,
): number
Updates the sample count of a render target texture
Parameters
- rtWrapper: Nullable<RenderTargetWrapper>
  defines the render target wrapper to update
- samples: number
  defines the sample count to set
Returns number
the effective sample count (could be 0 if multisample render targets are not supported)

See
https://doc.babylonjs.com/setup/support/webGL2#multisample-render-targets
Inherited from AbstractEngine.updateRenderTargetTextureSampleCount
- Defined in .temp/typedoc/docdirectory/doc.d.ts:119931
updateRenderTargetTextureSampleCount(
rtWrapper: Nullable<RenderTargetWrapper>,
samples: number,
): number
Updates the sample count of a render target texture
Parameters
- rtWrapper: Nullable<RenderTargetWrapper>
  defines the render target wrapper to update
- samples: number
  defines the sample count to set
Returns number
the effective sample count (could be 0 if multisample render targets are not supported)

See
https://doc.babylonjs.com/setup/support/webGL2#multisample-render-targets
Inherited from AbstractEngine.updateRenderTargetTextureSampleCount
- Defined in .temp/typedoc/docdirectory/doc.d.ts:121941

updateTextureData

updateTextureData(
    texture: InternalTexture,
    imageData: ArrayBufferView,
    xOffset: number,
    yOffset: number,
    width: number,
    height: number,
    faceIndex?: number,
    lod?: number,
    generateMipMaps?: boolean,
): void
Update a portion of an internal texture
Parameters
- texture: InternalTexture
  defines the texture to update
- imageData: ArrayBufferView
  defines the data to store into the texture
- xOffset: number
  defines the x coordinates of the update rectangle
- yOffset: number
  defines the y coordinates of the update rectangle
- width: number
  defines the width of the update rectangle
- height: number
  defines the height of the update rectangle
- OptionalfaceIndex: number
  defines the face index if texture is a cube (0 by default)
- Optionallod: number
  defines the lod level to update (0 by default)
- OptionalgenerateMipMaps: boolean
  defines whether to generate mipmaps or not
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112681

updateTextureDimensions

updateTextureDimensions(
    texture: InternalTexture,
    width: number,
    height: number,
    depth?: number,
): void
Update the dimensions of a texture
Parameters
- texture: InternalTexture
  texture to update
- width: number
  new width of the texture
- height: number
  new height of the texture
- Optionaldepth: number
  new depth of the texture
Returns void
Overrides AbstractEngine.updateTextureDimensions
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112652

updateTextureSamplingMode

updateTextureSamplingMode(
    samplingMode: number,
    texture: InternalTexture,
    generateMipMaps?: boolean,
): void
Update the sampling mode of a given texture
Parameters
- samplingMode: number
  defines the required sampling mode
- texture: InternalTexture
  defines the texture to update
- OptionalgenerateMipMaps: boolean
  defines whether to generate mipmaps for the texture
Returns void
Overrides AbstractEngine.updateTextureSamplingMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112644

updateTextureWrappingMode

updateTextureWrappingMode(
    texture: InternalTexture,
    wrapU: Nullable<number>,
    wrapV?: Nullable<number>,
    wrapR?: Nullable<number>,
): void
Update the sampling mode of a given texture
Parameters
- texture: InternalTexture
  defines the texture to update
- wrapU: Nullable<number>
  defines the texture wrap mode of the u coordinates
- OptionalwrapV: Nullable<number>
  defines the texture wrap mode of the v coordinates
- OptionalwrapR: Nullable<number>
  defines the texture wrap mode of the r coordinates
Returns void
Overrides AbstractEngine.updateTextureWrappingMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112660

updateUniformBuffer

updateUniformBuffer(
    uniformBuffer: DataBuffer,
    elements: FloatArray,
    offset?: number,
    count?: number,
): void
Update an existing uniform buffer
Parameters
- uniformBuffer: DataBuffer
  defines the target uniform buffer
- elements: FloatArray
  defines the content to update
- Optionaloffset: number
  defines the offset in the uniform buffer where update should start
- Optionalcount: number
  defines the size of the data to update
Returns void
See
https://doc.babylonjs.com/setup/support/webGL2#uniform-buffer-objets
Inherited from AbstractEngine.updateUniformBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:121784

updateVideoTexture

updateVideoTexture(
    texture: Nullable<InternalTexture>,
    video: HTMLVideoElement | Nullable<ExternalTexture>,
    invertY: boolean,
): void
Update a video texture
Parameters
- texture: Nullable<InternalTexture>
  defines the texture to update
- video: HTMLVideoElement | Nullable<ExternalTexture>
  defines the video element to use
- invertY: boolean
  defines if data must be stored with Y axis inverted
Returns void
Inherited from AbstractEngine.updateVideoTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:119889
updateVideoTexture(
    texture: Nullable<InternalTexture>,
    video: HTMLVideoElement | Nullable<ExternalTexture>,
    invertY: boolean,
): void
Update a video texture
Parameters
- texture: Nullable<InternalTexture>
  defines the texture to update
- video: HTMLVideoElement | Nullable<ExternalTexture>
  defines the video element to use
- invertY: boolean
  defines if data must be stored with Y axis inverted
Returns void
Inherited from AbstractEngine.updateVideoTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:121755

wipeCaches

wipeCaches(bruteForce?: boolean): void
Force the entire cache to be cleared You should not have to use this function unless your engine needs to share the webGL context with another engine
Parameters
- OptionalbruteForce: boolean
  defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
Returns void
Overrides AbstractEngine.wipeCaches
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112557

`Static`DefaultLoadingScreenFactory

DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen
Method called to create the default loading screen. This can be overridden in your own app.
Parameters
- canvas: HTMLCanvasElement
  The rendering canvas element
Returns ILoadingScreen
Inherited from AbstractEngine.DefaultLoadingScreenFactory
- Defined in .temp/typedoc/docdirectory/doc.d.ts:117249

`Static`isSupported

isSupported(): boolean
Gets a boolean indicating if the engine can be instantiated (ie. if a webGL context can be found)

Returns boolean
true if the engine can be created
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112823

`Static`MarkAllMaterialsAsDirty

MarkAllMaterialsAsDirty(
flag: number,
predicate?: (mat: Material) => boolean,
): void
Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
Parameters
- flag: number
  defines which part of the materials must be marked as dirty
- Optionalpredicate: (mat: Material) => boolean
  defines a predicate used to filter which materials should be affected
Returns void
Inherited from AbstractEngine.MarkAllMaterialsAsDirty
- Defined in .temp/typedoc/docdirectory/doc.d.ts:117272

Class ThinEngine

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ThinEngine

Properties

activeView

See

adaptToDeviceRatio

canvasTabIndex

cullBackFaces

currentRenderPassId

disableContextMenu

disableManifestCheck

disablePerformanceMonitorInBackground

disableUniformBuffers

disableVertexArrayObjects

enableOfflineSupport

enableUnpackFlipYCached

forcePOTTextures

ReadonlyhasOriginBottomLeft

hostInformation

inputElement

isFullscreen

ReadonlyisNDCHalfZRange

isPointerLock

loadingScreen

See

loadingUIBackgroundColor

See

loadingUIText

See

onAfterShaderCompilationObservable

ReadonlyonAfterViewRenderObservable

onBeforeShaderCompilationObservable

onBeforeTextureInitObservable

ReadonlyonBeforeViewRenderObservable

onBeginFrameObservable

onCanvasBlurObservable

onCanvasFocusObservable

onCanvasPointerOutObservable

onContextLostObservable

onContextRestoredObservable

ReadonlyonDisposeObservable

onEffectErrorObservable

onEndFrameObservable

onNewSceneAddedObservable

ReadonlyonReleaseEffectsObservable

onResizeObservable

postProcesses

premultipliedAlpha

preventCacheWipeBetweenFrames

renderEvenInBackground

scenes

skipFrameRender

ReadonlystartTime

ReadonlyuseExactSrgbConversions

validateShaderPrograms

views

Static_RescalePostProcessFactory

StaticaudioEngine

See

Deprecated

StaticAudioEngineFactory

Deprecated

StaticCollisionsEpsilon

StaticExceptionList

StaticOfflineProviderFactory

StaticQueueNewFrame

Type declaration

Parameters

Returns number

Accessors

activeRenderLoops

`Readonly`hasOriginBottomLeft

`Readonly`isNDCHalfZRange

`Readonly`onAfterViewRenderObservable

`Readonly`onBeforeViewRenderObservable

`Readonly`onDisposeObservable

`Readonly`onReleaseEffectsObservable

`Readonly`startTime

`Readonly`useExactSrgbConversions

`Static`_RescalePostProcessFactory

`Static`audioEngine

`Static`AudioEngineFactory

`Static`CollisionsEpsilon

`Static`ExceptionList

`Static`OfflineProviderFactory

`Static`QueueNewFrame