Edit

Share via


MixedRealitySceneSystem.SetLightingScene Method

Definition

Sets the current lighting scene. The lighting scene determines ambient light and skybox settings. It can optionally contain light objects. If the lighting scene is already loaded, no action will be taken. If a lighting scene transition is in progress, request will be queued and executed when the transition is complete.

public void SetLightingScene (string newLightingSceneName, Microsoft.MixedReality.Toolkit.SceneSystem.LightingSceneTransitionType transitionType = Microsoft.MixedReality.Toolkit.SceneSystem.LightingSceneTransitionType.None, float transitionDuration = 1);
abstract member SetLightingScene : string * Microsoft.MixedReality.Toolkit.SceneSystem.LightingSceneTransitionType * single -> unit
override this.SetLightingScene : string * Microsoft.MixedReality.Toolkit.SceneSystem.LightingSceneTransitionType * single -> unit
Public Sub SetLightingScene (newLightingSceneName As String, Optional transitionType As LightingSceneTransitionType = Microsoft.MixedReality.Toolkit.SceneSystem.LightingSceneTransitionType.None, Optional transitionDuration As Single = 1)

Parameters

newLightingSceneName
String
transitionType
LightingSceneTransitionType

The transition type to use. See LightingSceneTransitionType for information about each transition type.

transitionDuration
Single

The duration of the transition (if not None).

Implements

Applies to