Merge branch 'openmw-settings_docs' into 'master'

!2867 again

Closes #7027

See merge request OpenMW/openmw!2868

docs/source/reference/modding/settings/GUI.rst

@@ -40,7 +40,7 @@ tooltip delay
 -------------
 
 :Type:		floating point
-:Range:		> 0.0
+:Range:		>= 0.0
 :Default:	0.0
 
 This value determines the number of seconds between when you begin hovering over an item and when its tooltip appears.

docs/source/reference/modding/settings/lua.rst

@@ -41,7 +41,7 @@ This setting can only be configured by editing the settings configuration file.
 small alloc max size
 --------------------
 
-:Type:		integer
+:Type:		unsigned 64-bit integer
 :Range:		>= 0
 :Default:	1024
 
@@ -55,7 +55,7 @@ This setting can only be configured by editing the settings configuration file.
 memory limit
 ------------
 
-:Type:		integer
+:Type:		unsigned 64-bit integer
 :Range:		> 0
 :Default:	2147483648 (2GB)
 
@@ -78,7 +78,7 @@ This setting can only be configured by editing the settings configuration file.
 instruction limit per call
 --------------------------
 
-:Type:		integer
+:Type:		unsigned 64-bit integer
 :Range:		> 1000
 :Default:	100000000
 

docs/source/reference/modding/settings/stereo.rst

@@ -0,0 +1,64 @@
+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 :code:`GL_OVR_MultiView` and :code:`GL_OVR_MultiView2` extensions where possible.
+
+shared shadow maps
+------------------
+
+:Type:		boolean
+:Range:		True/False
+:Default:	True
+
+Use one set of shadow maps for both eyes.
+Will likely be significantly faster than the brute-force approach of rendering a separate copy for each eye with no or imperceptible quality loss.
+
+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 :ref:`[Stereo View]<Stereo View Settings>` 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

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.