Interface ICameraFader
Basic interface for fading in / out a color on a camera.
Namespace: Microsoft.MixedReality.Toolkit.Extensions.SceneTransitions
Assembly: cs.temp.dll.dll
Syntax
public interface ICameraFaderProperties
State
Declaration
CameraFaderState State { get; }Property Value
| Type | Description |
|---|---|
| CameraFaderState |
State
Declaration
CameraFaderState State { get; }Property Value
| Type | Description |
|---|---|
| CameraFaderState |
Methods
FadeInAsync(Single)
Applies a fade-in effect over time. Must be called after FadeOutAsync has completed.
Declaration
Task FadeInAsync(float fadeInTime)Parameters
| Type | Name | Description |
|---|---|---|
| Single | fadeInTime | The duration of the fade |
Returns
| Type | Description |
|---|---|
| Task |
FadeInAsync(Single)
Applies a fade-in effect over time. Must be called after FadeOutAsync has completed.
Declaration
Task FadeInAsync(float fadeInTime)Parameters
| Type | Name | Description |
|---|---|---|
| Single | fadeInTime | The duration of the fade |
Returns
| Type | Description |
|---|---|
| Task |
FadeOutAsync(Single, Color, IEnumerable<Camera>)
Applies a fade-out effect over time.
Declaration
Task FadeOutAsync(float fadeOutTime, Color color, IEnumerable<Camera> targets)Parameters
| Type | Name | Description |
|---|---|---|
| Single | fadeOutTime | The duration of the fade |
| Color | color | The color of the fade |
| IEnumerable<Camera> | targets | Which cameras will receive the effect |
Returns
| Type | Description |
|---|---|
| Task |
FadeOutAsync(Single, Color, IEnumerable<Camera>)
Applies a fade-out effect over time.
Declaration
Task FadeOutAsync(float fadeOutTime, Color color, IEnumerable<Camera> targets)Parameters
| Type | Name | Description |
|---|---|---|
| Single | fadeOutTime | The duration of the fade |
| Color | color | The color of the fade |
| IEnumerable<Camera> | targets | Which cameras will receive the effect |
Returns
| Type | Description |
|---|---|
| Task |
Initialize(SceneTransitionServiceProfile)
Initializes the camera fader class with a transition profile.
Declaration
void Initialize(SceneTransitionServiceProfile profile)Parameters
| Type | Name | Description |
|---|---|---|
| SceneTransitionServiceProfile | profile | The scene transition service profile. |
Initialize(SceneTransitionServiceProfile)
Initializes the camera fader class with a transition profile.
Declaration
void Initialize(SceneTransitionServiceProfile profile)Parameters
| Type | Name | Description |
|---|---|---|
| SceneTransitionServiceProfile | profile | The scene transition service profile. |
OnDestroy()
Used to destroy any assets created. May be called in middle of a transition.
Declaration
void OnDestroy()OnDestroy()
Used to destroy any assets created. May be called in middle of a transition.
Declaration
void OnDestroy()