 |
Tilt Five™ Unity API
1.4.1
|
|
|
Tilt Five™ Unity API
1.4.1
|
|
Public Attributes | |
| Camera | spectatorCamera |
| The camera used for rendering the onscreen preview More... | |
| GlassesMirrorMode | glassesMirrorMode = GlassesMirrorMode.None |
| The spectator camera will display content on screen depending on the mirroring mode. For example, if GlassesMirrorMode.LeftEye is set, the left eye camera's perspective will be displayed. More... | |
| PlayerIndex | spectatedPlayer = PlayerIndex.One |
| The player that will have their perspective mirrored on screen. More... | |
| LayerMask | cullingMask = ~0 |
| The culling mask to be used by the Spectator Camera. More... | |
| float | fieldOfView = 60f |
| The field of view to be used by the Spectator Camera. More... | |
| float | nearClipPlane = 0.3f |
| The near clip plane to be used by the Spectator Camera. More... | |
| float | farClipPlane = 1000f |
| The far clip plane to be used by the Spectator Camera. More... | |
| Rect | rect = new Rect(0, 0, 1, 1) |
| The viewport rect used by the Spectator Camera. More... | |
| RenderTexture | targetTexture = null |
| The target texture used by the Spectator Camera. More... | |
Definition at line 32 of file SpectatorSettings.cs.
| LayerMask TiltFive.SpectatorSettings.cullingMask = ~0 |
The culling mask to be used by the Spectator Camera.
The spectator camera's culling mask will be dynamically modified by the plugin (it will cull everything) if glassesMirrorMode isn't set to GlassesMirrorMode.None. As a result, if developers need to change the spectator camera's culling mask at runtime, their changes may be lost. To get around this, set this value instead, and it will be used to overwrite the spectator camera culling mask once the Tilt Five classes are finshed with working with it.
Definition at line 64 of file SpectatorSettings.cs.
| float TiltFive.SpectatorSettings.farClipPlane = 1000f |
The far clip plane to be used by the Spectator Camera.
The spectator camera's far clip plane will be dynamically modified by the plugin (it will conform to the eye cameras' far clip plane) if glassesMirrorMode isn't set to GlassesMirrorMode.None. As a result, if developers need to change the spectator camera's far clip plane at runtime, their changes may be lost. To get around this, set this value instead, and it will be used to overwrite the spectator camera far clip plane once the Tilt Five classes are finshed with working with it.
Definition at line 93 of file SpectatorSettings.cs.
| float TiltFive.SpectatorSettings.fieldOfView = 60f |
The field of view to be used by the Spectator Camera.
The spectator camera's field of view will be dynamically modified by the plugin (it will conform to the eye cameras' field of view) if glassesMirrorMode isn't set to GlassesMirrorMode.None. As a result, if developers need to change the spectator camera's FOV at runtime, their changes may be lost. To get around this, set this value instead, and it will be used to overwrite the spectator camera FOV once the Tilt Five classes are finshed with working with it.
Definition at line 74 of file SpectatorSettings.cs.
| GlassesMirrorMode TiltFive.SpectatorSettings.glassesMirrorMode = GlassesMirrorMode.None |
The spectator camera will display content on screen depending on the mirroring mode. For example, if GlassesMirrorMode.LeftEye is set, the left eye camera's perspective will be displayed.
If no mirroring mode is selected (i.e. GlassesMirrorMode.None), the spectator camera will render at the screen resolution / aspect ratio using a smoothed preview pose. This is generally recommended for release builds to give a better onscreen viewing experience, and it is significantly better for livestreaming or recording.
Definition at line 49 of file SpectatorSettings.cs.
Referenced by TiltFive.TiltFiveManager.Awake(), and TiltFive.TiltFiveManager.RefreshSpectatorSettings().
| float TiltFive.SpectatorSettings.nearClipPlane = 0.3f |
The near clip plane to be used by the Spectator Camera.
The spectator camera's near clip plane will be dynamically modified by the plugin (it will conform to the eye cameras' near clip plane) if glassesMirrorMode isn't set to GlassesMirrorMode.None. As a result, if developers need to change the spectator camera's near clip plane at runtime, their changes may be lost. To get around this, set this value instead, and it will be used to overwrite the spectator camera near clip plane once the Tilt Five classes are finshed with working with it.
Definition at line 84 of file SpectatorSettings.cs.
| Rect TiltFive.SpectatorSettings.rect = new Rect(0, 0, 1, 1) |
The viewport rect used by the Spectator Camera.
The spectator camera's viewport rect will be dynamically modifed by the plugin (it will conform to the eye cameras' aspect ratio) if glassesMirrorMode isn't set to GlassesMirrorMode.None. As a result, if developers need to change the spectator camera's viewport rect at runtime, their changes may be lost. To get around this, set this value instead, and it will be used to overwrite the spectator camera viewport rect once the Tilt Five classes are finshed with working with it.
Definition at line 103 of file SpectatorSettings.cs.
| PlayerIndex TiltFive.SpectatorSettings.spectatedPlayer = PlayerIndex.One |
The player that will have their perspective mirrored on screen.
Definition at line 54 of file SpectatorSettings.cs.
Referenced by TiltFive.TiltFiveManager.Awake(), TiltFive.SplitStereoCamera.OnRenderImage(), TiltFive.TiltFiveManager.RefreshSpectatorSettings(), TiltFive.TiltFiveManager2.RefreshSpectatorSettings(), TiltFive.TiltFiveManager.Update(), TiltFive.TiltFiveManager2.Update(), and TiltFive.Glasses.GlassesCore.Update().
| Camera TiltFive.SpectatorSettings.spectatorCamera |
The camera used for rendering the onscreen preview
Definition at line 37 of file SpectatorSettings.cs.
Referenced by TiltFive.TiltFiveManager.Awake(), TiltFive.TiltFiveManager.RefreshSpectatorSettings(), TiltFive.TiltFiveManager2.RefreshSpectatorSettings(), TiltFive.Glasses.GlassesCore.Reset(), TiltFive.TiltFiveManager.Update(), and TiltFive.TiltFiveManager2.Update().
| RenderTexture TiltFive.SpectatorSettings.targetTexture = null |
The target texture used by the Spectator Camera.
The spectator camera's target texture will be dynamically modifed by the plugin (it will be blitted to by the eye camera(s)) if glassesMirrorMode isn't set to GlassesMirrorMode.None. As a result, if developers need to change the spectator camera's target texture at runtime, their changes may be lost. To get around this, set this value instead, and it will be used to overwrite the spectator camera target texture once the Tilt Five classes are finshed with working with it.
Definition at line 113 of file SpectatorSettings.cs.
1.9.1