Babylon.js API documentation|

DefaultLoadingScreen

Class DefaultLoadingScreen

Class used for the default loading screen

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

Hierarchy

DefaultLoadingScreen

Implements

ILoadingScreen

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new DefaultLoadingScreen(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string): DefaultLoadingScreen

- Defined in .temp/docdirectory/doc.d.ts:37751
Creates a new default loading screen

Parameters
- _renderingCanvas: HTMLCanvasElement
  
  defines the canvas used to render the scene
- Optional _loadingText: string
  
  defines the default text to display
- Optional _loadingDivBackgroundColor: string
  
  defines the default background color
Returns DefaultLoadingScreen

Properties

Static DefaultLogoUrl Search playground for DefaultLogoUrl

DefaultLogoUrl: string

Gets or sets the logo url to use for the default loading screen

Static DefaultSpinnerUrl Search playground for DefaultSpinnerUrl

DefaultSpinnerUrl: string

Gets or sets the spinner url to use for the default loading screen

Accessors

loadingUIBackgroundColor

get loadingUIBackgroundColor(): string
set loadingUIBackgroundColor(color: string): void

Implementation of ILoadingScreen.loadingUIBackgroundColor
- Defined in .temp/docdirectory/doc.d.ts:37768
Gets or sets the color to use for the background

Returns string
Implementation of ILoadingScreen.loadingUIBackgroundColor
- Defined in .temp/docdirectory/doc.d.ts:37769
Gets or sets the color to use for the background

Parameters
- color: string
Returns void

loadingUIText

get loadingUIText(): string
set loadingUIText(text: string): void

Implementation of ILoadingScreen.loadingUIText
- Defined in .temp/docdirectory/doc.d.ts:37764
Gets or sets the text to display while loading

Returns string
Implementation of ILoadingScreen.loadingUIText
- Defined in .temp/docdirectory/doc.d.ts:37763
Gets or sets the text to display while loading

Parameters
- text: string
Returns void

Methods

displayLoadingUI Search playground for displayLoadingUI

displayLoadingUI(): void

Implementation of ILoadingScreen.displayLoadingUI
- Defined in .temp/docdirectory/doc.d.ts:37755
Function called to display the loading screen

Returns void

hideLoadingUI Search playground for hideLoadingUI

hideLoadingUI(): void

Implementation of ILoadingScreen.hideLoadingUI
- Defined in .temp/docdirectory/doc.d.ts:37759
Function called to hide the loading screen

Returns void