Skybox Plugin Briefing
This plugin encompasses a minimal plugin script that swaps the scene’s skybox material on certain TV events and the shader used to render various video modes of the skybox.
It supports equi-rectangular (aka panoramic) 360deg video and 180deg video as well as certain cubemap style 360 video renders.
It also supports Side-By-Side (SBS) and Over-Under (OU) 3D modes for VR.
Plugin Options
-
Tv
The ProTV instance that the plugin should register to. -
Skybox
This is the material that the plugin should assign to the skybox material when the TV is considered ACTIVE. The required shader to use is theVideo/Skybox
shader that this plugin provides, as this plugin directly updates properties on the shader. -
Fallback
This is the material that the plugin should assign to the skybox material when the TV is considered INACTIVE. This can be left empty and the plugin will automatically use the world’s existing material as the fallback. -
Brightness
This is a UI Slider that is used to determine the gamma exposure of the rendered video in the shader. Helps reduce eye strain in certain situations. -
The rest of the options are just for visual feedback of what state is active and do not have functional bearing on the plugin itself.
Events
The plugin considers the TV to be ACTIVE for the following TV events: _TvPlay
, _TvMediaStart
The plugin considers the TV to be INACTIVE for the following TV events: _TvMediaEnd
, _TvStop
, _TvVideoPlayerError
The following events handle updating the shader options for modifying the render output:
-
_Brightness
Applies the value of the Brightness slider to the exposure value of the shader. -
_Not3D
Disables any 3D mode. Make the shader render the whole video frame to both eyes in VR. -
_SideBySide
Enables the SBS mode. This 3D layout mode is most commonly used for 180deg video. -
_OverUnder
Enables the OU mode. This 3D layout mode is most commonly used for 360deg video. -
_Flip
Makes the shader render the video inverted vertically. This setting generally shouldn’t be needed, but sometimes the video may need to be flipped on certain platforms or videos. -
_SwapEyes
Makes the shader render the video to the opposing eyes when in a 3D mode. When in desktop mode, this swaps the render between each eye, since desktop can only see one eye at a time. -
_Deg180
Sets the render area to 1/2 the skybox. -
_Panoramic
Sets the render area to the whole skybox. -
_CubeMap
Sets the render area to use the whole skybox as well as interpret the video as having a cubemap style layout instead of the equi-rectangular layout.
Per-URL Settings
In order to allow for these settings to be applied on a per-URL basis (different videos should be handled uniquely), there is a meta info feature that the TV will extract from the URL if it’s present.
This is done by appending a #
to the URL and then specifying the settings you want applied, separating each by a ;
. For example https://vimeo.com/123456789#Panoramic;Standard