Language:
Page Info
Tags:
Engine Version:

VR Splash Screen Node Reference

Choose your OS:

VR Splash Screen Node Reference

The following breakdown covers what each one of the properties on the VR splash screen nodes does. When looking at the VR splash screen nodes, you will notice that there is a generic type and a type specific to Oculus. You should only use the Oculus-specific types when you are targeting Oculus HMDs. All other HMDs should use the generic type.

Generic Splash Screens

Enable Auto Loading Splash Screen

VRLS_EnableAutoLoading.png

Setting Name

Description

In Auto Show Enabled

If true, load the splash screen when a level is loaded.

Hide Splash Screen

VRLS_Hide_Splash.png

Setting Name

Description

Hide Splash Screen

Hides the splash screen.

Set Splash Screen

VRLS_Set_Splash.png

Setting Name

Description

Texture

Texture to use for the splash. Must be in B8R8G8A8 format.

Scale

Scale of the Texture.

Offest

Position from which to start rendering the Texture.

Show Loading Movie

Show a "loading" movie.

Show on Set

Show the Texture specified when the compositor is called.

Show Splash Screen

VRLS_Show_Splash.png

Setting Name

Description

Show Splash Screen

Shows the splash screen.

Oculus Specific Splash Screens

The following breakdown covers what each of the Oculus-specific splash screen nodes will do. Keep in mind that the following nodes should only be used when you are targeting Oculus HMDs.

Add Loading Splash Screen

VRLS_OC_Add_Loading.png

Setting Name

Description

Texture

A Texture asset to be used for the splash screen. Gear VR uses it as a path for loading icon; all other params are currently ignored by Gear VR.

Translation in Meters

Initial translation of the center of the splash screen in meters.

Rotation

Initial rotation of the splash screen, with the pivot at the center of the splash screen.

Size in Meters

Size, in meters, of the quad with the splash screen.

Delta Rotation

Incremental rotation added each 2nd frame to the quad's transform. The quad pivots around its center.

Clear Before Add

If true, clears splash before adding a new one.

Clear Loading Splash Screen

VRLS_OC_Clear_Loading_Splash.png

Setting Name

Description

Clear Loading Splash Screen

Removes all splash screens.

Enable Auto Loading Splash Screen

VRLS_OC_Enable_Auto_Load.png

Setting Name

Description

Auto Show Enabled

If true, automatic showing of splash screens is enabled when a map is being loaded.

Hide Loading Icon

VRLS_OC_Hide_Loading.png

Setting Name

Description

Hide Loading Icon

Clears the loading icon. This call will clear all the splashes.

Hide Loading Splash Screen

VRLS_OC_Hide_Loading_SS.png

Setting Name

Description

Clear

Clear all splash screen after hiding.

Is Auto Loading Splash Screen Enabled

VRLS_OC_IsAutoLoasding.png

Setting Name

Description

Is Auto Loading Splash Screen Enabled

Returns true if the splash screen is automatically shown when LoadMap is called.

Is Loading Icon Enabled

VRLS_OC_IsLoadingIconEnabled.png

Setting Name

Description

Is Loading Icon Enabled

Returns true if the splash screen is in loading icon mode.

Show Loading Splash Screen

VRLS_OC_ShowLoadingSplashScreen.png

Setting Name

Description

Show Loading Splash Screen

Shows loading splash screen.

Tags