FAST SDK Coding Reference 1.0.3
Loading...
Searching...
No Matches
WhiteScreenManager Class Reference

Manages GUI for a white screen saver to help reduce display burn-in. Not meant to be used directly. More...

Private Attributes

int durationMinutes = 30
 Settings, Inspector
The amount of time in minutes that the white screen is shown for.
 
bool isAxisInput = true
 Settings, Inspector
Set to true if joystick input should dismiss the white screen.
 
bool isKeypressInput = true
 Settings, Inspector
Set to true if key and mouse button press input should dismiss the white screen.
 
bool isMouseInput = true
 Settings, Inspector
Set to true if mouse input should dismiss the white screen.
 
bool isSerialInput = true
 Settings, Inspector
Set to true if serial input should dismiss the white screen.
 
bool isTouchInput = true
 Settings, Inspector
Set to true if touch input should dismiss the white screen.
 
bool isUdpInput = false
 Settings, Inspector
Set to true if UDP input should dismiss the white screen.
 
int serialInputCount = 10
 Settings, Inspector
The number of serial messages that must be recieved to dismiss the white screen.
 
int udpInputCount = 1
 Settings, Inspector
The number of UDP datagrams that must be recieved to dismiss the white screen.
 

Detailed Description

Manages GUI for a white screen saver to help reduce display burn-in. Not meant to be used directly.

Default functionality is included in the Startup Prefab.

Warning
If you find yourself trying to use FAST.WhiteScreenManager, you may want to review the Startup documentation to make sure you are following FAST best practices.
See also
UnityEngine.GameObject

Member Data Documentation

◆ durationMinutes

int durationMinutes = 30
private

Settings, Inspector
The amount of time in minutes that the white screen is shown for.

◆ isAxisInput

bool isAxisInput = true
private

Settings, Inspector
Set to true if joystick input should dismiss the white screen.

◆ isKeypressInput

bool isKeypressInput = true
private

Settings, Inspector
Set to true if key and mouse button press input should dismiss the white screen.

◆ isMouseInput

bool isMouseInput = true
private

Settings, Inspector
Set to true if mouse input should dismiss the white screen.

◆ isSerialInput

bool isSerialInput = true
private

Settings, Inspector
Set to true if serial input should dismiss the white screen.

◆ isTouchInput

bool isTouchInput = true
private

Settings, Inspector
Set to true if touch input should dismiss the white screen.

◆ isUdpInput

bool isUdpInput = false
private

Settings, Inspector
Set to true if UDP input should dismiss the white screen.

◆ serialInputCount

int serialInputCount = 10
private

Settings, Inspector
The number of serial messages that must be recieved to dismiss the white screen.

This can be helpful if the input is noisy or very sensitive.

◆ udpInputCount

int udpInputCount = 1
private

Settings, Inspector
The number of UDP datagrams that must be recieved to dismiss the white screen.

This can be helpful if the input is noisy or very sensitive.


The documentation for this class was generated from the following file: