diff --git a/docs/source/reference/modding/settings/stereo.rst b/docs/source/reference/modding/settings/stereo.rst new file mode 100644 index 0000000000..bf5eec183d --- /dev/null +++ b/docs/source/reference/modding/settings/stereo.rst @@ -0,0 +1,63 @@ +Stereo Settings +############### + +stereo enabled +-------------- + +:Type: boolean +:Range: True/False +:Default: False + +Enable/disable stereo view. This setting is ignored in VR. + +multiview +--------- + +:Type: boolean +:Range: True/False +:Default: False + +If enabled, OpenMW will use the GL_OVR_MultiView and GL_OVR_MultiView2 extensions where possible. + +shared shadow maps +------------------ + +:Type: boolean +:Range: True/False +:Default: True + +May accelerate the BruteForce method when shadows are enabled. + +allow display lists for multiview +--------------------------------- + +:Type: boolean +:Range: True/False +:Default: True + +If false, OpenMW-VR will disable display lists when using multiview. Necessary on some buggy drivers, but may incur a slight performance penalty. + +use custom view +--------------- + +:Type: boolean +:Range: True/False +:Default: False + +If false, the default OSG horizontal split will be used for stereo. +If true, the config defined in the [Stereo View] settings category will be used. + +.. note:: + This option is ignored in VR, and exists primarily for debugging purposes + +use custom eye resolution +------------------------- + +:Type: boolean +:Range: True/False +:Default: False + +If true, overrides rendering resolution for each eye. + +.. note:: + This option is ignored in VR, and exists primarily for debugging purposes diff --git a/docs/source/reference/modding/settings/stereoview.rst b/docs/source/reference/modding/settings/stereoview.rst new file mode 100644 index 0000000000..3e2e3e7231 --- /dev/null +++ b/docs/source/reference/modding/settings/stereoview.rst @@ -0,0 +1,218 @@ +Stereo View Settings +#################### + +eye resolution x +---------------- + +:Type: integer +:Range: > 0 +:Default: 3128 + +The default values are based on an HP Reverb G2 HMD. + +eye resolution y +---------------- + +:Type: integer +:Range: > 0 +:Default: 3060 + +The default values are based on an HP Reverb G2 HMD. + +left eye offset x +----------------- + +:Type: double precision floating point +:Range: any +:Default: -2.35 + +Left eye offset from center, expressed in MW units (1 meter = ~70). + +left eye offset y +----------------- + +:Type: double precision floating point +:Range: any +:Default: 0.0 + +Left eye offset from center, expressed in MW units (1 meter = ~70). + +left eye offset z +----------------- + +:Type: double precision floating point +:Range: any +:Default: 0.0 + +Left eye offset from center, expressed in MW units (1 meter = ~70). + +left eye orientation x +---------------------- + +:Type: double precision floating point +:Range: -1.0 to 1.0 +:Default: 0.0 + +Left eye orientation, expressed as a quaternion. + +left eye orientation y +---------------------- + +:Type: double precision floating point +:Range: -1.0 to 1.0 +:Default: 0.0 + +Left eye orientation, expressed as a quaternion. + +left eye orientation z +---------------------- + +:Type: double precision floating point +:Range: -1.0 to 1.0 +:Default: 0.0 + +Left eye orientation, expressed as a quaternion. + +left eye orientation w +---------------------- + +:Type: double precision floating point +:Range: -1.0 to 1.0 +:Default: 1.0 + +Left eye orientation, expressed as a quaternion. + +left eye fov left +----------------- + +:Type: double precision floating point +:Range: -π to π +:Default: -0.86 + +Left eye field of view, expressed in radians. + +left eye fov right +------------------ + +:Type: double precision floating point +:Range: -π to π +:Default: 0.78 + +Left eye field of view, expressed in radians. + +left eye fov up +--------------- + +:Type: double precision floating point +:Range: -π to π +:Default: 0.8 + +Left eye field of view, expressed in radians. + +left eye fov down +----------------- + +:Type: double precision floating point +:Range: -π to π +:Default: -0.8 + +Left eye field of view, expressed in radians. + +right eye offset x +------------------ + +:Type: double precision floating point +:Range: any +:Default: 2.35 + +Left eye offset from center, expressed in MW units (1 meter = ~70). + +right eye offset y +------------------ + +:Type: double precision floating point +:Range: any +:Default: 0.0 + +Left eye offset from center, expressed in MW units (1 meter = ~70). + +right eye offset z +------------------ + +:Type: double precision floating point +:Range: any +:Default: 0.0 + +Left eye offset from center, expressed in MW units (1 meter = ~70). + +right eye orientation x +----------------------- + +:Type: double precision floating point +:Range: -1.0 to 1.0 +:Default: 0.0 + +Left eye orientation, expressed as a quaternion. + +right eye orientation y +----------------------- + +:Type: double precision floating point +:Range: -1.0 to 1.0 +:Default: 0.0 + +Left eye orientation, expressed as a quaternion. + +right eye orientation z +----------------------- + +:Type: double precision floating point +:Range: -1.0 to 1.0 +:Default: 0.0 + +Left eye orientation, expressed as a quaternion. + +right eye orientation w +----------------------- + +:Type: double precision floating point +:Range: -1.0 to 1.0 +:Default: 1.0 + +Left eye orientation, expressed as a quaternion. + +right eye fov left +------------------ + +:Type: double precision floating point +:Range: -π to π +:Default: -0.78 + +Left eye field of view. + +right eye fov right +------------------- + +:Type: double precision floating point +:Range: -π to π +:Default: 0.86 + +Left eye field of view. + +right eye fov up +---------------- + +:Type: double precision floating point +:Range: -π to π +:Default: 0.8 + +Left eye field of view. + +right eye fov down +------------------ + +:Type: double precision floating point +:Range: -π to π +:Default: -0.8 + +Left eye field of view.